大网数据广告活动
磁盘与文件系统

JetGetRecordSize Function

· 52CE 我爱测

Learn more about: JetGetRecordSize Function

Applies to: Windows | Windows Server

JetGetRecordSize Function

The JetGetRecordSize function retrieves record size information from the desired location.

Windows Vista:  JetGetRecordSize is introduced in Windows Vista.

    JET_ERR JET_API JetGetRecordSize(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __out         JET_RECSIZE* precsize,
      __in          const JET_GRBIT grbit
    );

Parameters

sesid

Identifies the database session context that will be used for the API call.

tableid

Identifies the table or cursor that will be used for the API call. The cursor must be positioned on a record, or have an update prepared.

precsize

A pointer to an output buffer for the JET_RECSIZE structure.

grbit

This is one or more of the following values.

Value Meaning
JET_bitRecordSizeInCopyBuffer This retrieves the size of the record that is in the copy buffer prepared for update. Otherwise, the tableid or cursor must be positioned on a record, and that record will be used.
JET_bitRecordSizeRunningTotal When this bit is specified, the <a href="gg294072(v=exchg.10).md">JET_RECSIZE</a> is not zeroed before filling the contents, effectively acting as an accumulation of the statistics for multiple records visited or updated.
JET_bitRecordSizeLocal This causes the API to ignore non-intrinsic Long Values. For example, only the local record on the page will be used.

Return Value

This function returns the JET_ERR datatype with one of the following return codes. For more information about the possible ESE errors, see Extensible Storage Engine Errors and Error Handling Parameters.

Return code Description
JET_errSuccess The operation completed successfully.
JET_errInvalidGrbit One of the requested options was invalid or not implemented. This error will be returned by the JetGetRecordSize function when an illegal grbit is specified.
JET_errNotInitialized It is not possible to complete the operation because the instance associated with the session has not been initialized.
JET_errClientRequestToStopJetService It is not possible to complete the operation because all activity on the instance associated with the session has ceased as a result of a call to <a href="gg269240(v=exchg.10).md">JetStopService</a>.
JET_errInstanceUnavailable It is not possible to complete the operation because the instance associated with the session has encountered a fatal error that requires that access to all data be revoked to protect the integrity of that data.Windows XP:  JET_errInstanceUnavailable will only be returned by Windows XP and later releases.
JET_errTermInProgress It is not possible to complete the operation because the instance associated with the session is being shut down.
JET_errRestoreInProgress It is not possible to complete the operation because a restore operation is in progress on the instance associated with the session.
JET_errSessionSharingViolation It is illegal to use the same session from more than one thread at the same time.Windows XP:  JET_errInstanceUnavailable will only be returned by Windows XP and later releases.
JET_errNoCurrentRecord This can happen if the cursor was positioned incorrectly.
JET_errRecordDeleted If the cursor was not positioned in a transaction, this can happen if another thread deletes the record out from under this session.
JET_errInvalidParameter This can be returned if a NULLprecsize was passed.
Remarks

The size of the key accumulated in the cbOverhead field of JET_RECSIZE, is affected by JET_bitRecordSizeInCopyBuffer. If this bit is specified, the key size accumulated in the cbOverhead field is the full key size. If this bit is not used, then the key size accumulated will not include any size saved due to key prefix compression.

Requirements
Requirement Value
Client Requires Windows Vista.
Server Requires Windows Server 2008.
Header Declared in Esent.h.
Library Use ESENT.lib.
DLL Requires ESENT.dll.
See Also

JET_ERR
JET_GRBIT
JET_SESID
JET_RECSIZE
JET_TABLEID

Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.

资料来源与适用范围

资料来源
Microsoft Learn / Windows Win32 documentation
适用范围
Windows Win32 API · Source date 04/11/2016
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY 4.0 (documentation), MIT (code samples)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。