Compartilhar via


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

O método SetBackupOptions define uma cadeia de caracteres de parâmetros de backup privados ou dependentes do gravador para um componente.

Sintaxe

HRESULT SetBackupOptions(
  [in] VSS_ID             writerId,
  [in] VSS_COMPONENT_TYPE ct,
  [in] LPCWSTR            wszLogicalPath,
  [in] LPCWSTR            wszComponentName,
  [in] LPCWSTR            wszBackupOptions
);

Parâmetros

[in] writerId

Identificador do gravador.

[in] ct

Tipo do componente. Consulte VSS_COMPONENT_TYPE para obter os valores possíveis.

[in] wszLogicalPath

Cadeia de caracteres largos terminada em nulo que contém o caminho lógico do componente.

Para obter mais informações, consulte Caminhos lógicos de componentes.

O valor da cadeia de caracteres que contém o caminho lógico usado aqui deve ser o mesmo usado quando o componente foi adicionado ao conjunto de backup usando IVssBackupComponents::AddComponent.

O caminho lógico pode ser NULL.

Não há restrições nos caracteres que podem aparecer em um caminho lógico não NULL .

[in] wszComponentName

Cadeia de caracteres largos terminada em nulo que contém o nome do componente.

A cadeia de caracteres que contém o nome não pode ser NULL e deve conter o mesmo nome de componente que foi usado quando o componente foi adicionado ao conjunto de backup usando IVssBackupComponents::AddComponent.

[in] wszBackupOptions

Cadeia de caracteres largos terminada em nulo que contém os parâmetros de backup a serem definidos.

Retornar valor

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

Valor Significado
S_OK
Defina com êxito as opções de backup.
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_OBJECT_NOT_FOUND
O componente de backup não existe.
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.
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 em 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

A sintaxe exata e o conteúdo das opções de backup definidas pelo parâmetro wszBackupOptions do método SetBackupOptions dependerão do gravador específico que está sendo contatado.

Esse método deve ser chamado antes de IVssBackupComponents::P repareForBackup.

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

Confira também

IVssBackupComponents

IVssBackupComponents::P repareForBackup

IVssBackupComponents::SetRestoreOptions

VSS_COMPONENT_TYPE