Método CVssWriter::Initialize (vswriter.h)

Artigo
03/05/2025

Inicializa um objeto CVssWriter e permite que um aplicativo gravador interaja com o VSS.

Inicializar é um método público implementado pela classe base CVssWriter.

Sintaxe

HRESULT Initialize(
  [in] VSS_ID                     WriterId,
  [in] LPCWSTR                    wszWriterName,
  [in] VSS_USAGE_TYPE             ut,
  [in] VSS_SOURCE_TYPE            st,
  [in] VSS_APPLICATION_LEVEL      nLevel,
  [in] DWORD                      dwTimeoutFreeze,
  [in] VSS_ALTERNATE_WRITER_STATE aws,
  [in] bool                       bIOThrottlingOnly,
  [in] LPCWSTR                    wszWriterInstanceName
);

Parâmetros

[in] WriterId

O GUID (identificador global exclusivo) da classe de gravador.

[in] wszWriterName

Um cadeia de caracteres largaterminada em nulo que contém o nome do gravador. Essa cadeia de caracteres não está localizada.

[in] ut

Um valor de enumeração VSS_USAGE_TYPE que indica como os dados gerenciados pelo gravador são usados no sistema de host.

[in] st

Um valor de enumeração VSS_SOURCE_TYPE que indica o tipo de dados gerenciados pelo gravador.

[in] nLevel

Um valor de enumeração VSS_APPLICATION_LEVEL que indica o nível do aplicativo no qual o gravador recebe uma notificação de evento Congelar.

O valor padrão desse parâmetro é VSS_APP_FRONT_END.

[in] dwTimeoutFreeze

O tempo máximo permitido, em milissegundos, entre o recebimento de um gravador de uma notificação de evento Freeze e o recebimento de uma notificação de evento Thaw correspondente do VSS. Após o tempo limite expirar, o método CVssWriter::OnAbort do gravador é chamado automaticamente.

O valor padrão para esse parâmetro é 60000.

[in] aws

Um valor de enumeração VSS_ALTERNATE_WRITER_STATE que indica se o gravador tem um gravador alternativo associado.

O valor padrão desse parâmetro é VSS_AWS_NO_ALTERNATE_WRITER. O chamador não deve substituir esse valor padrão. Esse parâmetro é reservado para uso futuro.

[in] bIOThrottlingOnly

Defina esse parâmetro para verdadeiro se os métodos de limitação de E/S estiverem habilitados ou falso caso contrário.

O valor padrão desse parâmetro é falso. O chamador não deve substituir esse valor padrão. Esse parâmetro é reservado para uso futuro.

[in] wszWriterInstanceName

Um cadeia de caracteres wide terminadanulo que contém o nome da instância do gravador.

O valor padrão para esse parâmetro é NULL. Se o gravador tiver várias instâncias e exigir eventos de restauração, esse parâmetro será necessário e não poderá ser NULL. Para obter detalhes, consulte a seção Comentários a seguir.

Windows Server 2003 e Windows XP: Antes do Windows Server 2003 com SP1, esse parâmetro é reservado para uso do sistema e o chamador não deve substituir o valor padrão.

Valor de retorno

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

Valor	Significado
S_OK	Inicializou com êxito o objeto gravador.
S_FALSE	O objeto gravador não pôde ser inicializado; a infraestrutura de gravador do VSS estava inativa porque o Windows estava no modo de segurança ou estava configurando.
E_ACCESSDENIED	O chamador não é um administrador.
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_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 Windows 7. E_UNEXPECTED é usado em vez disso.

Observações

O VSS atribui uma ID de instância de gravador exclusiva a cada instância de um aplicativo gravador. Se mais de uma instância estiver presente no sistema ao mesmo tempo (por exemplo, se vários servidores SQL estiverem em execução em um sistema), cada gravador será identificado exclusivamente pela combinação de sua ID de classe de gravador e sua ID de instância de gravador.

O parâmetro wszWriterInstanceName permite que um gravador de várias instâncias especifique um nome persistente para cada instância de gravador como uma cadeia de caracteres legível por humanos. Esse nome deve ser exclusivo em todas as instâncias do gravador no sistema. Se um gravador tiver várias instâncias e exigir eventos de restauração, ele deverá especificar uma cadeia de caracteres NULLnão para esse parâmetro. O VSS usa o nome da instância para restaurar corretamente os gravadores de várias instâncias.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	vswriter.h (inclua Vss.h, VsWriter.h)
biblioteca	VssApi.lib