Função JetOSSnapshotPrepare

Aplica-se a: Windows | Windows Server

Função JetOSSnapshotPrepare

A função JetOSSnapshotPrepare inicia os preparativos para uma sessão de instantâneo. Uma sessão de instantâneo é um intervalo de tempo curto no qual o mecanismo não emite IOs de gravação em disco, de modo que o mecanismo possa participar de uma sessão de instantâneo de volume (quando impulsionado por um gravador de instantâneo).

Windows XP:JetOSSnapshotPrepare é introduzido no Windows XP.

    JET_ERR JET_API JetOSSnapshotPrepare(
      __out         JET_OSSNAPID* psnapId,
      __in          const JET_GRBIT grbit
    );

Parâmetros

psnapId

O identificador da sessão de instantâneo a ser iniciada.

grbit

As opções para essa chamada. Esse parâmetro pode ser uma combinação dos seguintes valores.

Valor	Significado
0	Instantâneo normal.
JET_bitIncrementalSnapshot	Somente arquivos de log serão obtidos.
JET_bitCopySnapshot	Um instantâneo de cópia (normal ou incremental) sem truncamento de log.
JET_bitContinueAfterThaw	A sessão de instantâneo ocorre após JetOSSnapshotThaw e exigirá uma chamada de função JetOSSnapshotEnd.
JET_bitExplicitPrepare	Nenhuma instância será preparada por padrão. Windows 7: JET_bitExplicitPrepare é introduzido no Windows 7.

Valor de retorno

Essa função retorna o tipo de dados JET_ERR com um dos seguintes códigos de retorno. Para obter mais informações sobre os possíveis erros do Mecanismo de Armazenamento Extensível (ESE), consulte Erros do Mecanismo de Armazenamento Extensível e Parâmetros de Tratamento de Erros.

Código de retorno	Descrição
JET_errSuccess	A operação foi concluída com sucesso.
JET_errInvalidParameter	O ponteiro de ID do instantâneo é NULL ou o parâmetro grbit é inválido.
JET_errOSSnapshotInvalidSequence	Uma sessão de instantâneo já está em andamento e a operação não tem permissão para ter mais de uma sessão de instantâneo em um determinado momento.

Se essa função for bem-sucedida, uma sessão de instantâneo poderá ser iniciada a qualquer momento com a fase de congelamento de E/S. O identificador da sessão será retornado e deverá ser usado nas chamadas subsequentes para a sessão de instantâneo.

As instâncias em execução do mecanismo agora serão consideradas parte da sessão de instantâneo.

Windows Vista: para especificar um subconjunto diferente de instâncias, o JetOSSnapshotPrepareInstance pode ser chamado.

A chamada de sequência de API normal é: JetOSSnapshotPrepare, opcionalmente seguida por uma ou mais chamadas a JetOSSnapshotPrepareInstance , seguida porJetOSSnapshotFreeze . Depois que o congelamento for iniciado, ele poderá ser encerrado usando JetOSSnapshotThaw. A qualquer momento após a preparação, a sessão de instantâneo pode ser encerrada abruptamente com JetOSSnapshotAbort.

Se JET_bitContinueAfterThaw for especificado após JetOSSnapshotThaw, a sessão de instantâneo permanecerá (embora a E/S seja retomada). Isso habilitará uma verificação do instantâneo e, se necessário, habilitará o truncamento de log usando JetOSSnapshotTruncateLog e exigirá uma chamada para JetOSSnapshotEnd.

Se essa função falhar, nenhuma alteração no estado do mecanismo ocorrerá.

Comentários

As entradas de log de eventos serão geradas para as diferentes etapas do instantâneo.

Requisitos

Requisito	Valor
Cliente	Exige o Windows Vista ou o Windows XP.
Servidor	Exige o Windows Server 2008 ou o Windows Server 2003.
Cabeçalho	Declarado em Esent.h.
Biblioteca	Use ESENT.lib.
DLL	Requer o ESENT.dll.

Confira também

JET_ERR
JET_OSSNAPID
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepareInstance
JetOSSnapshotThaw
JetOSSnapshotTruncateLog