ReadLogNotification function

The ReadLogNotification function retrieves notifications from the log manager. It retrieves a queued notification from the log manager immediately if a notification is available; otherwise the request remains pending until a notification is generated.

Syntax

CLFSUSER_API BOOL ReadLogNotification(
  IN HANDLE                   hLog,
  OUT PCLFS_MGMT_NOTIFICATION pNotification,
  IN LPOVERLAPPED             lpOverlapped
);

Parameters

hLog

The handle to the log.

pNotification

Receives the notification type, and if the type has parameters associated with it, the parameters.

lpOverlapped

A pointer to an OVERLAPPED structure that is required for asynchronous operation. If asynchronous operation is not used, this parameter can be NULL.

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 is a possible error code:

Remarks

If the log handle is not created with the FILE_FLAG_OVERLAPPED file option, no operations can start on the log handle while the call to ReadLogNotification is pending.

Requirements

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

See also

CLFS_MGMT_NOTIFICATION

OVERLAPPED