Compartilhar via


Método IVssComponent::GetBackupMetadata (vswriter.h)

O método GetBackupMetadata recupera metadados de backup privados específicos do gravador que podem ter sido definidos durante um evento PrepareForBackup por CVssWriter::OnPrepareBackup usando IVssComponent::SetBackupMetadata.

Somente um gravador pode chamar esse método.

Sintaxe

HRESULT GetBackupMetadata(
  [out] BSTR *pbstrData
);

Parâmetros

[out] pbstrData

O endereço de uma variável alocada pelo chamador que recebe uma cadeia de caracteres que contém os metadados de backup que foram adicionados durante um evento OnPrepareBackup .

Retornar valor

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

Valor Significado
S_OK
Retornou com êxito o valor do atributo.
S_FALSE
Não há metadados de backup associados a esse componente.
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_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 em VSS.

Comentários

Esse método pode ser chamado a qualquer momento, dependendo da lógica de um determinado gravador.

Se nenhum metadado de backup tiver sido definido, GetBackupMetadata retornará S_FALSE.

Se a chamada para GetBackupMetadata for bem-sucedida, o chamador será responsável por liberar a cadeia de caracteres retornada no parâmetro pbstrMetadata chamando a função SysFreeString .

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 vswriter.h (inclua Vss.h, VsWriter.h)
Biblioteca VssApi.lib

Confira também

IVssComponent

IVssComponent::SetBackupMetadata