GetLogFileInformation function (clfsw32.h)

Returns a buffer that contains metadata about a specified log and its current state, which is defined by the CLFS_INFORMATION structure.

Data that is obtained reflects the state of the log only at the time when the call is made. Typically, a client can continue to cache and use fields from this structure until the next time that it appends records or writes its restart area. At that time, some of the information becomes stale.

Syntax

CLFSUSER_API BOOL GetLogFileInformation(
  [in]      HANDLE            hLog,
  [in, out] PCLFS_INFORMATION pinfoBuffer,
  [in, out] PULONG            cbBuffer
);

Parameters

[in] hLog

A handle to an open log that is obtained from a successful call to CreateLogFile.

The log handle can refer to a dedicated or multiplexed log.

[in, out] pinfoBuffer

A pointer to a user-allocated CLFS_INFORMATION structure that receives the log metadata.

[in, out] cbBuffer

A pointer to a variable that on input specifies the size, in bytes, of the metadata buffer pointed to by pinfoBuffer.

On output, it specifies the number of bytes that are actually copied into pinfoBuffer.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

The following list identifies the possible error codes:

Requirements

See also

CLFS_INFORMATION

Common Log File System Functions

CreateLogFile

Obtaining the Next LSN