ClfsReserveAndAppendLog 函数 (wdm.h)

ClfsReserveAndAppendLog 例程在封送区域中保留空间,或者将记录追加到封送区或以原子方式执行。

语法

CLFSUSER_API NTSTATUS ClfsReserveAndAppendLog(
  [in]            PVOID             pvMarshalContext,
  [in, optional]  PCLFS_WRITE_ENTRY rgWriteEntries,
  [in]            ULONG             cWriteEntries,
  [in, optional]  PCLFS_LSN         plsnUndoNext,
  [in, optional]  PCLFS_LSN         plsnPrevious,
  [in]            ULONG             cReserveRecords,
  [in, out]       PLONGLONG         rgcbReservation,
  [in]            ULONG             fFlags,
  [out, optional] PCLFS_LSN         plsn
);

参数

[in] pvMarshalContext

指向表示与 CLFS 流关联的封送区域的不透明上下文的指针。 调用方之前通过调用 ClfsCreateMarshallingArea获取此指针。

[in, optional] rgWriteEntries

指向 CLFS_WRITE_ENTRY 结构的数组的指针,每个结构都包含指向数据缓冲区的指针,该缓冲区将成为追加到日志的记录的一部分。 如果 cWriteEntries 为零,则可以将此参数 NULL

[in] cWriteEntries

rgWriteEntries指向的数组中的元素数。 如果 rgWriteEntriesNULL,则此参数必须为零。

[in, optional] plsnUndoNext

指向 CLFS_LSN 结构的指针,该结构提供要追加的记录的撤消下一个 LSN。

[in, optional] plsnPrevious

指向CLFS_LSN结构的指针,该结构提供要追加的记录的上一个 LSN。

[in] cReserveRecords

rgcbReservation指向的数组中的元素数。 如果 rgcbReservationNULL,或者设置了 fFlags 的CLFS_FLAG_USE_RESERVATION标志,则此参数必须为零。

[in, out] rgcbReservation

指向 LONGLONG 类型变量数组的指针。 调用方将数组的每个元素设置为必须为其保留空间的记录的大小(以字节为单位)。 返回时,每个数组元素接收为记录保留的空间的实际大小。 这包括标头和对齐所需的空间。 如果预留值为负值,则会释放与提供的负值的绝对值最接近的保留记录。 如果 cReserveRecords 为零,并且如果设置了 fF lags 的CLFS_FLAG_USE_RESERVATION标志,则必须 NULL,则可以 NULL

[in] fFlags

此参数可以是零或以下标志的任意组合。

意义
CLFS_FLAG_FORCE_APPEND 将当前记录追加到日志 I/O 块后,块将排队(以 LSN 顺序排列)到稳定的存储。 此标志无法保证记录强制存储稳定(请参阅CLFS_FLAG_FORCE_FLUSH)。
CLFS_FLAG_FORCE_FLUSH 将当前记录追加到日志 I/O 块后,该块将强制转换为稳定的存储。
CLFS_FLAG_USE_RESERVATION 当前记录放置在封送区域中日志 I/O 块中的保留空间中。 封送区域中的保留记录数减少一个。 如果设置了此标志,cReserveRecords 必须为零,rgcbReservation 必须 NULL

[out, optional] plsn

指向接收追加记录 LSN 的 CLFS_LSN 结构的指针。 如果 cWriteEntries 为零,则可以将此参数 NULL

返回值

ClfsReserveAndAppendLog 如果成功,则返回STATUS_SUCCESS;否则,它将返回 Ntstatus.h 中定义的错误代码之一。

言论

ClfsReserveAndAppendLog 例程根据存在可选参数和CLFS_USE_RESERVATION标志的状态更改其基本行为。 下表汇总了常见方案。

参数和标志值 执行的作
cWriteEntries = 0。

rgWriteEntries = NULL

plsn = NULL

保留一组记录的空间,但不将记录追加到封送区域。 rgcbReservation 参数提供需要保留空间的每个记录的数据部分的大小。
cWriteEntries > 0。

rgWriteEntriesNULL

plsnNULL

cReserveRecords = 0。

rgcbReservationNULL

已设置CLFS_USE_RESERVATION。

使用已保留的空间将记录追加到封送区域。 将保留的记录空间数减少一个。
cWriteEntries > 0。

rgWriteEntriesNULL

plsnNULL

cReserveRecords = 0。

rgcbReservationNULL

清除CLFS_USE_RESERVATION。

通过保留新空间将记录追加到封送区域。 保留的记录空间数保持不变。
cWriteEntries > 0。

rgWriteEntriesNULL

plsnNULL

cReserveRecords> 0。

rgcbReservation 不 NULL

清除CLFS_USE_RESERVATION标志。

通过保留新空间将记录追加到封送区域。 此外,还会保留一组目前未追加的记录的空间。 rgcbReservation 参数提供需要保留空间的每个记录的大小。 通过将 cReserveRecords的值来增加保留的记录空间数。
 

调用 ClfsReserveAndAppendLog 等效于调用 ClfsReserveAndAppendLogAlignedcbEntryAlignment 参数设置为 1。

有关 CLFS 概念和术语的说明,请参阅 通用日志文件系统

要求

要求 价值
最低支持的客户端 在 Windows Server 2003 R2、Windows Vista 和更高版本的 Windows 中可用。
目标平台 桌面
标头 wdm.h (包括 Wdm.h)
Clfs.lib
DLL Clfs.sys
IRQL <= APC_LEVEL

另请参阅

CLFS_LSN

CLFS_WRITE_ENTRY

ClfsCreateMarshallingArea

ClfsReserveAndAppendLogAligned