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

Artigo
03/03/2024

O método GetWriterMetadata retorna os metadados de um gravador específico em execução no sistema.

Sintaxe

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

Parâmetros

[in] iWriter

Índice do gravador cujos metadados devem ser recuperados. O valor desse parâmetro é um inteiro de 0 a n–1 inclusive, em que n é o número total de gravadores no sistema atual. O valor de n é retornado por IVssBackupComponents::GetWriterMetadataCount.

[out] pidInstance

Ponteiro para o identificador de instância do gravador que coletou os metadados.

[out] ppMetadata

Ponteiro indireto duplamente para a instância do objeto IVssExamineWriterMetadata que contém os metadados retornados.

Retornar valor

Veja a seguir os códigos de retorno válidos para esse método.

Valor	Significado
S_OK	Retornou com êxito um ponteiro para um objeto de interface IVssExamineWriterMetadata .
E_INVALIDARG	Um dos valores de parâmetro não é válido.
E_OUTOFMEMORY	O chamador está sem memória ou outros recursos do sistema.
VSS_E_BAD_STATE	O objeto de componentes de backup não é inicializado, esse método foi chamado durante uma operação de restauração ou esse método não foi chamado dentro da sequência correta.
VSS_E_INVALID_XML_DOCUMENT	O documento XML não é válido. Verifique o log de eventos para obter detalhes. Para obter mais informações, consulte Tratamento de eventos e erros no VSS.
VSS_E_OBJECT_NOT_FOUND	A cópia de sombra especificada não existe.
VSS_E_UNEXPECTED	Erro inesperado. O código de erro é registrado no arquivo de log de erros. Para obter mais informações, consulte Tratamento de eventos e erros no VSS. Windows Server 2008, Windows Vista, Windows Server 2003 e Windows XP: Esse valor não tem suporte até o Windows Server 2008 R2 e o Windows 7. E_UNEXPECTED é usado.

Comentários

Um solicitante deve chamar a operação assíncrona IVssBackupComponents::GatherWriterMetadata e aguardar sua conclusão antes de chamar GetWriterMetadata.

Embora IVssBackupComponents::GatherWriterMetadata precise ser chamado antes de uma operação de restauração ou backup, GetWriterMetadata normalmente não é chamado para restaurações.

As informações de componente recuperadas (durante operações de backup) usando IVssExamineWriterMetadata::GetComponent, em que a interface IVssExamineWriterMetadata foi retornada por GetWriterMetadata, vêm do Documento de Metadados do Gravador de um processo de gravador ao vivo.

Isso contrasta com as informações retornadas por GetWriterComponents (durante operações de restauração), que foram armazenadas no Documento de Componentes de Backup por chamadas para AddComponent.

Quando o chamador desse método terminar de acessar os metadados, ele deverá chamar IUnknown::Release.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	vsbackup.h (inclua VsBackup.h, Vss.h, VsWriter.h)
Biblioteca	VssApi.lib