Função JetOSSnapshotGetFreezeInfo

Aplica-se a: Windows | Windows Server

Função JetOSSnapshotGetFreezeInfo

A função JetOSSnapshotGetFreezeInfo recupera a lista de instâncias e bancos de dados que fazem parte da sessão instantâneo a qualquer momento.

Windows Vista:JetOSSnapshotGetFreezeInfo é introduzido no Windows Vista.

    JET_ERR JET_API JetOSSnapshotGetFreezeInfo(
      __in          const JET_OSSNAPID snapId,
      __out         unsigned long* pcInstanceInfo,
      __out         JET_INSTANCE_INFO** paInstanceInfo,
      __in          const JET_GRBIT grbit
    );

Parâmetros

snapId

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

pcInstanceInfo

O número de instâncias em execução no momento que fazem parte da sessão instantâneo.

paInstanceInfo

Uma matriz de estruturas, uma para cada instância em execução, descrevendo a instância e os bancos de dados que fazem parte dela.

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 do 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_errOutOfMemory	A função falhou devido a uma condição de falta de memória.
JET_errInvalidParameter	pcInstanceInfo ou paInstanceInfo é NULL.
JET_errOSSnapshotInvalidSnapId	O identificador da sessão de instantâneo não é válido.
JET_errOSSnapshotInvalidSequence	Uma sessão instantâneo não está em andamento.

Se essa função for bem-sucedida, as informações da instância serão preenchidas corretamente e deverão ser liberadas posteriormente chamando JetFreeBuffer com o ponteiro para a matriz de informações da instância retornada.

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

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.
Unicode	Implementado como JetOSSnapshotGetFreezeInfoW (Unicode) e JetOSSnapshotGetFreezeInfoA (ANSI).

Consulte Também

Parâmetros de tratamento de erros
Erros extensíveis do mecanismo de armazenamento
JET_ERR
JetFreeBuffer
JetOSSnapshotAbort
JetOSSnapshotFreeze
JetOSSnapshotThaw