ClfsAlignReservedLog function (wdm.h)

Article
02/25/2022

The ClfsAlignReservedLog routine calculates the size of the space that must be reserved for a specified set of records. The size calculation includes the space required for headers and the space required for sector alignment.

Syntax

CLFSUSER_API NTSTATUS ClfsAlignReservedLog(
  [in]  PVOID       pvMarshalContext,
  [in]  ULONG       cRecords,
  [in]  LONGLONG [] rgcbReservation,
  [out] PLONGLONG   pcbAlignReservation
);

Parameters

[in] pvMarshalContext

A pointer to an opaque context that represents a marshalling area associated with a CLFS stream. The caller previously obtained this pointer by calling ClfsCreateMarshallingArea.

[in] cRecords

The number of elements in the array pointed to by rgcbReservation.

[in] rgcbReservation

A pointer to an array of LONGLONG-typed variables that supplies a list of record sizes (in bytes).

[out] pcbAlignReservation

A pointer to a LONGLONG-typed variable that receives the size, in bytes, of the required reservation.

Return value

ClfsAlignReservedLog returns STATUS_SUCCESS if it succeeds; otherwise, it returns one of the error codes defined in Ntstatus.h.

Remarks

For an explanation of CLFS concepts and terminology, see Common Log File System.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Server 2003 R2, Windows Vista, and later versions of Windows.
Target Platform	Desktop
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL