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

Un escritor llama al método OnPrepareBackup después de un evento PrepareForBackup . Este método se usa para configurar el estado de un escritor y sus componentes como preparación para una operación de copia de seguridad.

OnPrepareBackup es un método virtual. Se implementa mediante la clase base CVssWriter , pero se puede invalidar mediante clases derivadas.

Sintaxis

bool OnPrepareBackup(
  [in] IVssWriterComponents *pComponent
);

Parámetros

[in] pComponent

Puntero a una instancia de un objeto IVssWriterComponents que contiene el contenido del documento de metadatos de escritor. El valor de este parámetro puede ser NULL si el solicitante no admite componentes (si CVssWriter::AreComponentsSelected devuelve false).

Valor devuelto

Tal como lo implementa la clase base, OnPrepareBackup siempre devuelve true.

Cualquier otra implementación de este método debe devolver true , excepto en el caso de un error irrecuperable. Si se produce un error irrecuperable, el método debe llamar al método CVssWriter::SetWriterFailure para proporcionar una descripción del error antes de devolver false. Si se produce un error nofatal, el método debe llamar a SetWriterFailure pero devolver true. Si el error se debe a un problema transitorio, el método debe especificar VSS_E_WRITERERROR_RETRYABLE en la llamada a SetWriterFailure.

En todos los casos en los que se produce un error, el método debe escribir un evento en el registro de eventos para notificar el motivo exacto del error.

Comentarios

La implementación predeterminada de este método por la clase base CVssWriter devuelve true sin realizar ninguna otra operación.

OnPrepareBackup proporciona a un escritor una oportunidad para seleccionar de forma más fina lo que se realizará una copia de seguridad.

Controlar el evento PrepareForBackup es la última oportunidad para que un escritor obtenga acceso a los metadatos contenidos en el documento componentes de copia de seguridad antes de la creación de la instantánea.

Por lo tanto, OnPrepareBackup ofrece una oportunidad para que el escritor realice las adiciones o actualizaciones finales a la información de componente almacenada (mediante la interfaz IVssComponent ). En concreto, los metadatos específicos del escritor se pueden actualizar mediante IVssComponent::SetBackupMetadata o IVssComponent::SetRestoreMetadata.

Además, al controlar el evento PrepareForSnapshot proporciona otra oportunidad en el ciclo de vida de una operación de copia de seguridad de VSS para realizar operaciones que consumen mucho tiempo (como sincronizar datos entre varios sitios), OnPrepareBackup ofrece la oportunidad de que el escritor inicie dicha operación de forma asincrónica. Las tareas como estas deben completarse antes de la devolución de CVssWriter::OnPrepareSnapshot.

Los escritores nunca deben iniciar una excepción de este método ni de ningún otro CVssWriter(Ex)::OnXxx método de devolución de llamada.

Un solicitante genera un evento PrepareForBackup , que desencadena una llamada a OnPrepareBackup mediante una llamada a IVssBackupComponents::P repareForBackup.

Si este método llama al método CVssWriterEx2::GetSessionId, CVssWriter::SetWriterFailure o CVssWriterEx2::SetWriterFailureEx , debe hacerlo en el mismo subproceso que llamó a este método. Para obtener más información, vea Writer Event Handling.

Requisitos

Consulte también

CVssWriter

CVssWriter::OnPostSnapshot

CVssWriter::OnPreRestore

CVssWriter::SetWriterFailure

IVssWriterComponents