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

El método GetWriterStatus devuelve el estado del escritor especificado.

Sintaxis

HRESULT GetWriterStatus(
  [in]  UINT             iWriter,
  [out] VSS_ID           *pidInstance,
  [out] VSS_ID           *pidWriter,
  [out] BSTR             *pbstrWriter,
  [out] VSS_WRITER_STATE *pnStatus,
  [out] HRESULT          *phResultFailure
);

Parámetros

[in] iWriter

Índice del escritor cuyos metadatos se van a recuperar. El valor de este parámetro es un entero comprendido entre 0 y n-1, donde n es el número total de escritores del sistema actual. IVssBackupComponents::GetWriterStatusCount devuelve el valor de n.

[out] pidInstance

Dirección de una variable asignada por el autor de la llamada que recibe el identificador de instancia del escritor.

[out] pidWriter

Dirección de una variable asignada por el autor de la llamada que recibe el identificador de la clase writer.

[out] pbstrWriter

Dirección de una variable asignada por el autor de la llamada que recibe una cadena que contiene el nombre del escritor especificado.

[out] pnStatus

Dirección de una variable asignada por el autor de la llamada que recibe un valor de enumeración VSS_WRITER_STATE .

[out] phResultFailure

Dirección de una variable asignada por el autor de la llamada que recibe el código de error HRESULT devuelto por el escritor.

A continuación se muestran los valores admitidos para pHrResultFailure.

Valor Significado
S_OK
El escritor se realizó correctamente.
VSS_E_WRITERERROR_INCONSISTENTSNAPSHOT
La instantánea contiene solo un subconjunto de los volúmenes necesarios para que el escritor realice correctamente una copia de seguridad del componente de la aplicación.
VSS_E_WRITERERROR_OUTOFRESOURCES
El escritor se quedó sin memoria u otros recursos del sistema. La manera recomendada de controlar este código de error es esperar diez minutos y, a continuación, repetir la operación, hasta tres veces.
VSS_E_WRITERERROR_TIMEOUT
Error en la operación de escritura debido a un tiempo de espera entre los eventos Freeze y Thaw. La manera recomendada de controlar este código de error es esperar diez minutos y, a continuación, repetir la operación, hasta tres veces.
VSS_E_WRITERERROR_RETRYABLE
Error en el sistema de escritura debido a un error que probablemente no se produciría si se reiniciaba todo el proceso de creación de copias de seguridad, restauración o instantánea. La manera recomendada de controlar este código de error es esperar diez minutos y, a continuación, repetir la operación, hasta tres veces.
VSS_E_WRITERERROR_NONRETRYABLE
Error en la operación de escritura debido a un error que podría repetirse si se crea otra instantánea. Para obtener más información, vea Control de eventos y errores en VSS.
VSS_E_WRITER_NOT_RESPONDING
El escritor no responde.
VSS_E_WRITER_STATUS_NOT_AVAILABLE
El estado del escritor no está disponible para uno o varios escritores. Un escritor puede haber alcanzado el número máximo de sesiones de copia de seguridad y restauración disponibles.

Windows Vista, Windows Server 2003 y Windows XP: Este valor no se admite.

Valor devuelto

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

Valor Significado
S_OK
Se devolvió correctamente el estado del escritor especificado. Tenga en cuenta que el valor del parámetro pHrWriterFailure debe comprobarse para comprobar que el sistema de escritura se realizó correctamente. Los códigos de error del sistema de escritura pueden estar entre los enumerados en VsWriter.h y en Errores y Vetas de escritor.
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_BAD_STATE
El objeto de componentes de copia de seguridad no se inicializa, se ha llamado a este método durante una operación de restauración o no se ha llamado a este método dentro de la secuencia correcta.
VSS_E_OBJECT_NOT_FOUND
El escritor especificado no existe.
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

Un solicitante debe llamar a la operación asincrónica IVssBackupComponents::GatherWriterStatus y esperar a que se complete antes de llamar a GetWriterStatus.

Cuando el autor de la llamada ha terminado de obtener acceso a la información de estado devuelta por este método, debe llamar a SysFreeString para liberar la memoria que mantiene el parámetro pbstrWriter .

Los valores VSS_E_WRITERERROR_XXX devueltos en el parámetro pHrResultFailure se generan mediante escritores. VSS genera VSS_E_WRITER_NOT_RESPONDING y VSS_E_WRITER_STATUS_NOT_AVAILABLE.

Requisitos

Requisito Value
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 vsbackup.h (incluya VsBackup.h, Vss.h, VsWriter.h)
Library VssApi.lib

Consulte también

IVssBackupComponents

IVssBackupComponents::GatherWriterStatus

IVssBackupComponents::GetWriterStatusCount