Función JetOSSnapshotPrepareInstance

Se aplica a: Windows | Windows Server

Función JetOSSnapshotPrepareInstance

La función JetOSSnapshotPrepareInstance selecciona una instancia específica para formar parte de la sesión de instantáneas.

Windows Vista:JetOSSnapshotPrepareInstance se introdujo en Windows Vista.

JET_ERR JET_API JetOSSnapshotPrepareInstance(
  __in          JET_OSSNAPID snapId,
  __in          JET_INSTANCE instance,
  __in          const JET_GRBIT grbit
);

Parámetros

snapId

Identificador de la sesión de instantánea.

instance

Instancia que se usará para esta llamada.

grbit

Las opciones de esta llamada. Este parámetro se reserva para uso futuro. El único valor válido es 0 (cero).

Valor devuelto

Esta función devuelve el tipo de datos JET_ERR con uno de los siguientes códigos de retorno. Para obtener más información sobre los posibles errores de ESE, vea Extensible Storage Engine Errors and Error Handling Parameters.

Código devuelto	Descripción
JET_errSuccess	La operación se ha completado correctamente.
JET_errInvalidParameter	El puntero de identificador de instantánea es NULL o el parámetro grbit no es válido.
JET_errOSSnapshotInvalidSequence	Ya hay una sesión de instantánea en curso.
JET_errOSSnapshotInvalidSnapId	El identificador de la sesión de instantáneas no es válido.

Si esta función se realiza correctamente, la instancia especificada formará parte de la sesión de instantáneas.

Si se produce un error en esta función, no se produce ningún cambio en el estado del motor.

Comentarios

La llamada normal a la secuencia de API es: JetOSSnapshotPrepare, seguido opcionalmente de una o varias llamadas a JetOSSnapshotPrepareInstance, seguidas de JetOSSnapshotFreeze. Una vez iniciada la inmovilización, se puede finalizar mediante JetOSSnapshotThaw. En cualquier momento después de la preparación, la sesión de instantáneas se puede finalizar repentinamente con JetOSSnapshotAbort. Las entradas del registro de eventos se generarán para los distintos pasos de la instantánea.

Si no se llama a JetOSSnapshotPrepareInstance entre el inicio de la sesión (JetOSSnapshotPrepare) y el momento de inmovilización (JetOSSnapshotFreeze), todas las instancias en ejecución del motor se inmovilizarán y formarán parte de la sesión de instantáneas. Esto ocurre por dos motivos:

• Simplifica el código de los usuarios que desean todas las instancias.

• Permite la compatibilidad con versiones anteriores para los autores de llamadas de las API de instantáneas.

Requisitos

Requisito	Value
Cliente	Requiere Windows Vista.
Servidor	Requiere Windows Server 2008.
Encabezado	Declarado en Esent.h.
Library	Use ESENT.lib.
Archivo DLL	Requiere ESENT.dll.

Consulte también

Parámetros de control de errores
Errores del motor de almacenamiento extensible
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw