Função JetGetInstanceInfo

Aplica-se a: Windows | Windows Server

Função JetGetInstanceInfo

A função JetGetInstanceInfo recupera informações sobre as instâncias em execução.

Windows XP: JetGetInstanceInfo é introduzido no Windows XP.

    JET_ERR JET_API JetGetInstanceInfo(
      __out         unsigned long* pcInstanceInfo,
      __out         JET_INSTANCE_INFO** paInstanceInfo
    );

Parâmetros

pcInstanceInfo

Um ponteiro para um buffer que receberá o número de elementos armazenados em paInstanceInfo.

paInstanceInfo

Um ponteiro para um buffer que receberá o endereço do primeiro elemento de uma matriz de estruturas.

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_errInvalidParameter

Um dos parâmetros fornecidos continha um valor inesperado ou continha um valor que não fazia sentido quando combinado com o valor de outro parâmetro. Esse erro será retornado por JetGetInstanceInfo quando:

  • pcInstanceInfo ou paInstanceInfo são NULL.

JET_errOutOfMemory

Não há memória suficiente para processar a solicitação.

Comentários

O mecanismo de banco de dados alocará uma matriz de estruturas de JET_INSTANCE_INFO . O chamador é responsável por liberar essa memória com JetFreeBuffer.

Se não houver instâncias ativas, JetGetInstanceInfo retornará JET_errSuccess e pcInstanceInfo receberá um valor de 0.

Requisitos

Requisito Valor

Cliente

Requer o Windows Vista ou o Windows XP.

Servidor

Requer o Windows Server 2008 ou o Windows Server 2003.

Cabeçalho

Declarado em Esent.h.

Biblioteca

Use ESENT.lib.

DLL

Requer ESENT.dll.

Unicode

Implementado como JetGetInstanceInfoW (Unicode) e JetGetInstanceInfoA (ANSI).

Consulte Também

JET_ERR
JET_INSTANCE
JET_INSTANCE_INFO
JetFreeBuffer