Compartilhar via


Função JetGetErrorInfoW

Aplica-se a: Windows | Windows Server

Função JetGetErrorInfoW

A função JetGetErrorInfoW BAS_ do mecanismo de banco de dados.

Observação: esta documentação se baseia em uma versão preliminar do Mecanismo de Armazenamento Extensível. Essas informações estão sujeitas a alterações.

JET_ERR JET_API JetGetErrorInfoW( 
    _In_opt_ void *                      pvContext, 
    _Out_writes_bytes_( cbMax ) void *   pvResult, 
    _In_ unsigned long                   cbMax, 
    _In_ unsigned long                   InfoLevel, 
    _In_ JET_GRBIT                       grbit );

Parâmetros

pvContext

O valor de contexto ou erro para o qual as informações de erro estendidas são necessárias. O valor passado depende do valor do parâmetro InfoLevel .

pvResult

Um ponteiro para um buffer que receberá as informações. O tipo do buffer depende do valor do parâmetro InfoLevel . O chamador deve ser configurado para alinhar o buffer adequadamente.

cbMax

O tamanho máximo da estrutura pvResult passada.

InfoLevel

O tipo de informação que será recuperada para as informações/contexto de erro é especificado pelo parâmetro pvContext . O formato dos dados armazenados no pvResult depende do InfoLevel.

A tabela a seguir lista os valores possíveis para esse parâmetro.

Valor

Significado

JET_ErrorInfoSpecificErr

pvContext é interpretado como um código de JET_ERR/erro, pvResult é interpretado como um JET_ERRINFOBASIC_W e os campos da estrutura JET_ERRINFOBASIC_W são preenchidos adequadamente.

grbit

Reservado.

Valor Retornado

Essa função retorna o tipo de dados JET_ERR com um dos códigos de retorno listados na tabela a seguir. 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

Um dos parâmetros fornecidos contém um valor inesperado ou contém um valor que não faz sentido quando combinado com o valor de outro parâmetro. Isso pode acontecer para JetGetErrorInfo quando ocorre o seguinte:

  • O valor do parâmetro InfoLevel especificado é inválido.

  • O valor de grbit especificado é inválido.

  • O valor cbMax do buffer de parâmetro pvResult especificado é menor que o tamanho necessário para a saída desse parâmetro InfoLevel.

  • Para InfoLevel = JET_ErrorInfoSpecificErr, o valor de JET_ERR passado é desconhecido para o mecanismo.

JET_errDisabledFunctionality

Se essa SKU do Windows não der suporte a essa função, esse erro será retornado.

Em caso de êxito, o buffer de saída apropriado para o contexto/valor de erro solicitado será definido como as informações de erro estendidas solicitadas.

Em caso de falha, o estado dos buffers de saída será indefinido.

Comentários

A função JET_ERRINFOBASIC_W e JET_ERRCAT grupo de constantes contêm documentação sobre as informações de erro estendidas retornadas para InfoLevel = JET_ErrorInfoSpecificErr.

Requisitos

Requisito Valor

Cliente

Requer Windows 8.

Servidor

Requer Windows 8 Server.

Cabeçalho

Declarado em Esent.h.

Biblioteca

Use ESENT.lib.

DLL

Requer ESENT.dll.

Unicode

Observação: somente o JetGetErrorInfoW (Unicode) é implementado. Essa API não tem uma versão A (ANSI).