ValidateLog function (clfsw32.h)

Validates the consistency of the log metadata and data before log archive and after log restore.

Syntax

CLFSUSER_API BOOL ValidateLog(
  [in]            LPCWSTR               pszLogFileName,
  [in, optional]  LPSECURITY_ATTRIBUTES psaLogFile,
  [out, optional] PCLFS_INFORMATION     pinfoBuffer,
  [in, out]       PULONG                pcbBuffer
);

Parameters

[in] pszLogFileName

The name of the log.

The name is specified when creating the log by using CreateLogFile. The following example identifies the format to use:

Log:<LogName>[::<LogStreamName>]

<LogName> corresponds to a valid file path in the file system.

<LogStreamName> is the unique name of a log stream in the dedicated log.

For more information, see Log Types.

[in, optional] psaLogFile

A pointer to a SECURITY_ATTRIBUTES structure that specifies the security attributes of a log.

This parameter can be NULL.

[out, optional] pinfoBuffer

A pointer to a CLFS_INFORMATION structure that receives log metadata.

[in, out] pcbBuffer

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

On output, it receives the amount of information that is copied to the buffer, in bytes.

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

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 R2 [desktop apps only]
Target Platform	Windows
Header	clfsw32.h
Library	Clfsw32.lib
DLL	Clfsw32.dll

See also

CLFS_INFORMATION

Common Log File System Functions

SECURITY_ATTRIBUTES