ClfsMgmtRegisterManagedClient function (wdm.h)

Article
02/22/2024

The ClfsMgmtRegisterManagedClient routine creates a client that will manage a CLFS log.

Syntax

CLFSUSER_API NTSTATUS ClfsMgmtRegisterManagedClient(
  [in] PLOG_FILE_OBJECT               LogFile,
  [in] PCLFS_MGMT_CLIENT_REGISTRATION RegistrationData,
       PCLFS_MGMT_CLIENT              ClientCookie
);

Parameters

[in] LogFile

A pointer to a LOG_FILE_OBJECT structure that represents the CLFS log stream that the client created by ClfsMgmtRegisterManagedClient will manage.

[in] RegistrationData

An instance of the CLFS_MGMT_CLIENT_REGISTRATION structure that contains the functions that will be used to manage the log.

ClientCookie

The cookie we give back to the caller for future use of the API.

Return value

The ClfsMgmtRegisterManagedClient routine returns one of the following NTSTATUS values:

Return code	Description
STATUS_SUCCESS	A client has been created to manage the log.
STATUS_UNSUCCESSFUL	CLFS management was not able to create a client to manage the log.
STATUS_INSUFFICIENT_RESOURCES	There is insufficient memory to complete the operation.
STATUS_INVALID_PARAMETER	An input parameter is invalid.

This routine might also return other NTSTATUS Values.

Remarks

The Client parameter that is provided by the ClfsMgmtRegisterManagedClient routine is a required parameter for other CLFS management functions. You should store this value for later use.

A client application must be ready for its callback routine to be called as soon as it calls the ClfsMgmtRegisterManagedClient routine.

More than one client can register with a log stream.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Server 2003 R2, Windows Vista, and later versions of Windows.
Target Platform	Desktop
Header	wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL