Método IVssBackupComponents::GetWriterMetadata (vsbackup.h)

Artículo
03/13/2024

El método GetWriterMetadata devuelve los metadatos de un escritor específico que se ejecuta en el sistema.

Sintaxis

HRESULT GetWriterMetadata(
  [in]  UINT                      iWriter,
  [out] VSS_ID                    *pidInstance,
  [out] IVssExamineWriterMetadata **ppMetadata
);

Parámetros

[in] iWriter

Índice del escritor cuyos metadatos se van a recuperar. El valor de este parámetro es un entero comprendido entre 0 y n-1, donde n es el número total de escritores del sistema actual. IVssBackupComponents::GetWriterMetadataCount devuelve el valor de n.

[out] pidInstance

Puntero al identificador de instancia del escritor que recopiló los metadatos.

[out] ppMetadata

Puntero indirecto doblemente a la instancia del objeto IVssExamineWriterMetadata que contiene los metadatos devueltos.

Valor devuelto

A continuación se muestran los códigos de retorno válidos para este método.

Valor	Significado
S_OK	Devolvió correctamente un puntero a un objeto de interfaz IVssExamineWriterMetadata .
E_INVALIDARG	Uno de los valores de parámetro no es válido.
E_OUTOFMEMORY	El autor de la llamada no tiene memoria u otros recursos del sistema.
VSS_E_BAD_STATE	El objeto de componentes de copia de seguridad no se inicializa, se ha llamado a este método durante una operación de restauración o no se ha llamado a este método dentro de la secuencia correcta.
VSS_E_INVALID_XML_DOCUMENT	El documento XML no es válido. Compruebe el registro de eventos para obtener más información. Para obtener más información, vea Control de eventos y errores en VSS.
VSS_E_OBJECT_NOT_FOUND	La instantánea especificada no existe.
VSS_E_UNEXPECTED	error inesperado. El código de error se registra en el archivo de registro de errores. Para obtener más información, vea Control de eventos y errores en VSS. Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP: Este valor no se admite hasta Windows Server 2008 R2 y Windows 7. E_UNEXPECTED se usa en su lugar.

Comentarios

Un solicitante debe llamar a la operación asincrónica IVssBackupComponents::GatherWriterMetadata y esperar a que se complete antes de llamar a GetWriterMetadata.

Aunque se debe llamar a IVssBackupComponents::GatherWriterMetadata antes de una operación de restauración o copia de seguridad, No se suele llamar a GetWriterMetadata para restauraciones.

La información de componentes recuperada (durante las operaciones de copia de seguridad) mediante IVssExamineWriterMetadata::GetComponent, donde la interfaz IVssExamineWriterMetadata ha sido devuelta por GetWriterMetadata, procede del documento de metadatos de escritor de un proceso de escritor activo.

Esto contrasta con la información devuelta por GetWriterComponents (durante las operaciones de restauración), que se almacenó en el documento componentes de copia de seguridad mediante llamadas a AddComponent.

Cuando el autor de la llamada de este método termine de acceder a los metadatos, debe llamar a IUnknown::Release.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	vsbackup.h (incluya VsBackup.h, Vss.h, VsWriter.h)
Library	VssApi.lib