Partilhar via

Função JetGetObjectInfo

Aplica-se a: Windows | Windows Server

Função JetGetObjectInfo

A função JetGetObjectInfo recupera informações sobre objetos de banco de dados. Atualmente, apenas tabelas são suportadas. JetGetTableInfo pode ser usado para buscar mais informações do que JetGetObjectInfo.

    JET_ERR JET_API JetGetObjectInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          JET_OBJTYP objtyp,
      __in_opt      const tchar* szContainerName,
      __in_opt      const tchar* szObjectName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

Parâmetros

Sesídeo

O contexto da sessão do banco de dados a ser usado.

Dbid

A base de dados a partir da qual as informações são recuperadas.

objtyp

Os objetos que contêm informações a serem recuperadas. Atualmente, apenas JET_objtypNil e JET_objtypTable são suportados, ambos se comportando de forma idêntica. Apenas as tabelas serão recuperadas.

szContainerName

Este parâmetro é reservado para uso futuro e passa NULL. O nome dos tipos de objetos sobre os quais recuperar informações.

szObjectName

O nome do objeto que contém informações a serem recuperadas. Quando o InfoLevel usa as opções JET_ObjInfoList ou JET_ObjInfoListNoStats para recuperar uma lista de todos os objetos, esse valor deve ser NULL ou uma cadeia de caracteres vazia.

Atualmente, apenas nomes de tabelas são suportados.

pvResultado

Ponteiro para um buffer que recebe as informações especificadas.

O tamanho do buffer, em bytes, é passado em cbMax. Em caso de falha, o conteúdo de pvResult é indefinido.

As informações armazenadas no pvResult dependem do InfoLevel.

cbMax

O tamanho, em bytes, do buffer passado em pvResult.

Nível de Informação

Especifica o tipo de informação a ser recuperada para o objeto especificado. Isso afeta como pvResult é interpretado.

As opções a seguir estão disponíveis para definir esse parâmetro.

Valor

Significado

JET_ObjInfo

pvResult é interpretado como uma estrutura JET_OBJECTINFO .

A estrutura JET_OBJECTINFO é preenchida com informações referentes ao objeto nomeado em szObjectName.

Se o chamador não quiser saber o número de registros e páginas do objeto, considere usar JET_ObjInfoNoStats nível de informação, que pode ser mais rápido, já que as estatísticas não estão incluídas.

JET_ObjInfoList

pvResult é interpretado como uma estrutura JET_OBJECTLIST . As informações sobre todos os objetos são recuperadas. Uma tabela temporária será criada e as informações necessárias para atravessar a tabela temporária serão descritas na estrutura JET_OBJECTLIST . Para obter mais informações, consulte JET_OBJECTLIST. Se o chamador não quiser saber o número de registros e páginas do objeto, considere usar JET_ObjInfoListNoStats, que pode ser mais rápido.

JET_ObjInfoListACM

Preterido e sem suporte no momento.

JET_ObjInfoListNoStats

pvResult é interpretado como uma estrutura JET_OBJECTLIST . As informações sobre todos os objetos são recuperadas. Uma tabela temporária será criada e as informações necessárias para atravessar a tabela temporária serão descritas na estrutura JET_OBJECTLIST . Para obter mais informações, consulte JET_OBJECTLIST. JET_ObjInfoListNoStats é idêntico ao JET_ObjInfoList, exceto que as colunas que relatam o número de registros (columnidcRecord) e páginas (columnidcPage) não serão atualizadas.

JET_ObjInfoMax

pvResult é interpretado como um JET_OBJECTINFO. O tamanho máximo do objeto está em páginas. Atualmente, apenas as tabelas serão devolvidas.

JET_ObjInfoNoStats

pvResult é interpretado como um JET_OBJECTINFO. Informações sobre apenas o objeto fornecido em szObjectName serão recuperadas.

A estrutura JET_OBJECTINFO será preenchida com informações referentes ao objeto nomeado em szObjectName.

JET_ObjInfoNoStats é idêntico ao JET_ObjInfo, exceto que os campos que relatam o número de registros e páginas são definidos como zero.

JET_ObjInfoRulesLoaded

Preterido e sem suporte no momento.

JET_ObjInfoSysTabCursor

Preterido e sem suporte no momento.

JET_ObjInfoSysTabReadOnly

Preterido e sem suporte no momento.

Valor de retorno

Esta 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 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 êxito.

JET_errBufferTooSmall

O tamanho do buffer fornecido no cbMax era muito pequeno para armazenar as informações desejadas.

JET_errInvalidName

Um nome inválido foi dado em szObjectName ou szContainerName.

JET_errInvalidParameter

Um parâmetro ruim foi dado. É possível que um nível ruim tenha sido passado para o InfoLevel.

Observações

Se JetGetObjectInfo criar com êxito uma tabela temporária (por exemplo, JET_ObjInfoList ou JET_ObjInfoNoStats), o chamador será responsável por fechar a tabela temporária com JetCloseTable.

Atualmente, JetGetObjectInfo suporta apenas a recuperação de informações sobre tabelas.

Requerimentos

Requisito Valor

Cliente

Requer Windows Vista, Windows XP ou Windows 2000 Professional.

Servidor

Requer Windows Server 2008, Windows Server 2003 ou Windows 2000 Server.

Cabeçalho

Declarado em Esent.h.

Biblioteca

Use ESENT.lib.

DLL

Requer ESENT.dll.

Unicode

Implementado como JetGetObjectInfoW (Unicode) e JetGetObjectInfoA (ANSI).

Ver também

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo

  • Last updated on