RegisterManageableLogClient function (clfsmgmtw32.h)

Article
02/22/2024

The RegisterManageableLogClient function registers a client with the log manager. A client can specify whether to receive notifications by using callbacks, or have the notifications queued for retrieval by using ReadLogNotification.

Syntax

CLFSUSER_API BOOL RegisterManageableLogClient(
  [in] HANDLE                    hLog,
  [in] PLOG_MANAGEMENT_CALLBACKS pCallbacks
);

Parameters

[in] hLog

The handle to the log to register. Only one registration per unique opening of the log is allowed.

[in] pCallbacks

Specifies the callbacks that the client is registering for. Valid callbacks are enumerated by LOG_MANAGEMENT_CALLBACKS. Specify zero to queue notifications instead.

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.

Remarks

A client can deregister either by closing the log handle, or by calling DeregisterManageableLogClient.

Examples

For an example that uses this function, see Creating a Log File.

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	clfsmgmtw32.h
Library	Clfsw32.lib
DLL	Clfsw32.dll