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


BOOL WINAPI ReadLogNotification(
  _In_  HANDLE                  hLog,
  _Out_ PCLFS_MGMT_NOTIFICATION pNotification,
  _In_  LPOVERLAPPED            lpOverlapped
);

Parameters

hLog [in]

The handle to the log.

pNotification [out]

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

lpOverlapped [in]

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:

ERROR_IO_PENDING

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]

Header

Clfsmgmtw32.h

Library

Clfsw32.lib

DLL

Clfsw32.dll

See also

CLFS_MGMT_NOTIFICATION
OVERLAPPED

 

 

Community Additions

ADD
Show: