Função JetOSSnapshotPrepareInstance
Aplica-se a: Windows | Windows Server
Função JetOSSnapshotPrepareInstance
A função JetOSSnapshotPrepareInstance seleciona uma instância específica para fazer parte da sessão instantâneo.
Windows Vista:JetOSSnapshotPrepareInstance foi introduzido no Windows Vista.
JET_ERR JET_API JetOSSnapshotPrepareInstance(
__in JET_OSSNAPID snapId,
__in JET_INSTANCE instance,
__in const JET_GRBIT grbit
);
Parâmetros
snapId
O identificador da sessão instantâneo.
instance
A instância que será usada para essa chamada.
grbit
As opções para essa chamada. Esse parâmetro é reservado para uso futuro. O único valor válido é 0 (zero).
Valor Retornado
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 de ESE, consulte Erros extensíveis do mecanismo de armazenamento 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 instantâneo id é NULL ou o parâmetro grbit é inválido. |
JET_errOSSnapshotInvalidSequence |
Uma sessão instantâneo já está em andamento. |
JET_errOSSnapshotInvalidSnapId |
O identificador da sessão instantâneo não é válido. |
Se essa função for bem-sucedida, a instância especificada fará parte da sessão instantâneo.
Se essa função falhar, nenhuma alteração no estado do mecanismo ocorrerá.
Comentários
A chamada de sequência de API normal é: JetOSSnapshotPrepare, opcionalmente seguida por uma ou mais chamadas para JetOSSnapshotPrepareInstance e seguida por JetOSSnapshotFreeze. 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. As entradas do log de eventos serão geradas para as diferentes etapas do instantâneo.
Se JetOSSnapshotPrepareInstance não for chamado entre o início da sessão (JetOSSnapshotPrepare) e o momento de congelamento (JetOSSnapshotFreeze), todas as instâncias em execução no mecanismo congelarão e se tornarão parte da sessão instantâneo. Isso ocorre por dois motivos:
Ele simplifica o código para usuários que desejam todas as instâncias.
Ele permite a compatibilidade com versões anteriores para os chamadores das APIs instantâneo.
Requisitos
Requisito | Valor |
---|---|
Cliente |
Requer o Windows Vista. |
Servidor |
Requer o Windows Server 2008. |
Cabeçalho |
Declarado em Esent.h. |
Biblioteca |
Use ESENT.lib. |
DLL |
Requer ESENT.dll. |
Consulte Também
Parâmetros de tratamento de erro
Erros extensíveis do mecanismo de armazenamento
JET_ERR
JetOSSnapshotAbort
JetOSSnapshotEnd
JetOSSnapshotFreeze
JetOSSnapshotPrepare
JetOSSnapshotThaw