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

Artículo
03/08/2023

Inicializa un objeto CVssWriter y permite que una aplicación de escritor interactúe con VSS.

Initialize es un método público implementado por la clase base CVssWriter .

Sintaxis

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

Identificador único global (GUID) de la clase writer.

[in] wszWriterName

Cadena de caracteres anchos terminada en NULL que contiene el nombre del escritor. Esta cadena no está localizada.

[in] ut

Valor de enumeración VSS_USAGE_TYPE que indica cómo se usan los datos administrados por el escritor en el sistema host.

[in] st

Valor de enumeración VSS_SOURCE_TYPE que indica el tipo de datos administrados por el escritor.

[in] nLevel

Valor de enumeración VSS_APPLICATION_LEVEL que indica el nivel de aplicación en el que el escritor recibe una notificación de evento Freeze .

El valor predeterminado de este parámetro es VSS_APP_FRONT_END.

[in] dwTimeoutFreeze

El tiempo máximo permitido, en milisegundos, entre la recepción de un escritor de una notificación de evento Freeze y la recepción de una notificación de eventos Thaw coincidente de VSS. Una vez expirado el tiempo de espera, se llama automáticamente al método CVssWriter::OnAbort del escritor.

El valor predeterminado de este parámetro es 60000.

[in] aws

Valor de enumeración VSS_ALTERNATE_WRITER_STATE que indica si el escritor tiene asociado un escritor alternativo.

El valor predeterminado de este parámetro es VSS_AWS_NO_ALTERNATE_WRITER. El autor de la llamada no debe invalidar este valor predeterminado. Este parámetro se reserva para uso futuro.

[in] bIOThrottlingOnly

Establezca este parámetro en true si los métodos de limitación de E/S están habilitados o false en caso contrario.

El valor predeterminado de este parámetro es false. El autor de la llamada no debe invalidar este valor predeterminado. Este parámetro se reserva para uso futuro.

[in] wszWriterInstanceName

Cadena de caracteres anchos terminada en NULL que contiene el nombre de la instancia de escritor.

El valor predeterminado de este parámetro es NULL. Si el escritor tiene varias instancias y requiere eventos de restauración, este parámetro es obligatorio y no puede ser NULL. Para obtener más información, consulte la siguiente sección Comentarios.

Windows Server 2003 y Windows XP: Antes de Windows Server 2003 con SP1, este parámetro está reservado para uso del sistema y el autor de la llamada no debe invalidar el valor predeterminado.

Valor devuelto

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

Value	Significado
S_OK	Inicializó correctamente el objeto writer.
S_FALSE	No se pudo inicializar el objeto writer; la infraestructura del escritor de VSS estaba inactiva porque Windows estaba en modo seguro o estaba configurando.
E_ACCESSDENIED	El autor de la llamada no es un administrador.
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_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

VSS asigna un identificador de instancia de escritor único a cada instancia de una aplicación de escritor. Si hay más de una instancia en el sistema al mismo tiempo (por ejemplo, si varios servidores SQL Server se ejecutan en un sistema), cada escritor se identifica de forma única mediante la combinación de su identificador de clase de escritor y su identificador de instancia de escritor.

El parámetro wszWriterInstanceName permite a un escritor de varias instancias especificar un nombre persistente para cada instancia de escritor como una cadena legible. Este nombre debe ser único en todas las instancias del escritor del sistema. Si un escritor tiene varias instancias y requiere eventos de restauración, debe especificar una cadena que no sea NULL para este parámetro. VSS usa el nombre de instancia para restaurar correctamente los escritores de varias instancias.

Requisitos


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