JetGetErrorInfoW 函数

适用于: Windows |Windows Server

JetGetErrorInfoW 函数

JetGetErrorInfoW 函数BAS_数据库引擎。

注意:本文档基于可扩展存储引擎的初步版本。 此信息可能随时发生更改。

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 );

参数

pvContext

需要扩展错误信息的上下文或错误值。 传入的值取决于 InfoLevel 参数值。

pvResult

指向将接收信息的缓冲区的指针。 缓冲区的类型取决于 InfoLevel 参数值。 调用方必须配置为适当对齐缓冲区。

cbMax

传入的 pvResult 结构的最大大小。

InfoLevel

将为错误信息/上下文检索的信息类型由 pvContext 参数指定。 pvResult 中存储的数据的格式取决于 InfoLevel

下表列出了此参数的可能值。

含义

JET_ErrorInfoSpecificErr

pvContext 解释为 JET_ERR/错误代码, pvResult 解释为 JET_ERRINFOBASIC_W,并适当填充 JET_ERRINFOBASIC_W 结构的字段。

grbit

保留。

返回值

此函数使用下表中列出的返回代码之一返回 JET_ERR 数据类型。 有关可能的 ESE 错误的详细信息,请参阅 可扩展存储引擎错误错误处理参数

返回代码

说明

JET_errSuccess

操作已成功完成。

JET_errInvalidParameter

提供的其中一个参数包含意外值,或包含与另一个参数的值组合时没有意义的值。 发生以下情况时 ,JetGetErrorInfo 可能会发生这种情况:

  • 指定的 InfoLevel 参数值无效。

  • 指定的 grbit 值无效。

  • 指定的 pvResult 参数缓冲区的 cbMax 值小于此 InfoLevel 参数输出所需的大小。

  • 对于 InfoLevel = JET_ErrorInfoSpecificErr,传入 的JET_ERR 值对引擎未知。

JET_errDisabledFunctionality

如果 Windows 的此 SKU 不支持此函数,将返回此错误。

成功后,适用于所请求错误上下文/值的输出缓冲区将设置为请求的扩展错误信息。

失败时,输出缓冲区的状态将不确定。

备注

JET_ERRINFOBASIC_W 函数和JET_ERRCAT组常量包含有关 InfoLevel = JET_ErrorInfoSpecificErr 返回的扩展错误信息的文档。

要求

要求

客户端

需要Windows 8。

服务器

需要 Windows 8 服务器。

标头

在 Esent.h 中声明。

Library

使用 ESENT.lib。

DLL

需要ESENT.dll。

Unicode

注意:仅实现 JetGetErrorInfoW (Unicode) 。 此 API 没有 A (ANSI) 版本。