ClfsMgmtQueryPolicy function (wdm.h)

  • Article

The ClfsMgmtQueryPolicy routine retrieves a specific CLFS_MGMT_POLICY structure for a log.

Syntax

CLFSUSER_API NTSTATUS ClfsMgmtQueryPolicy(
  [in]  PLOG_FILE_OBJECT      LogFile,
  [in]  CLFS_MGMT_POLICY_TYPE PolicyType,
  [out] PCLFS_MGMT_POLICY     Policy,
  [out] PULONG                PolicyLength
);

Parameters

[in] LogFile

A pointer to a LOG_FILE_OBJECT structure that represents the CLFS log whose policy is being retrieved.

[in] PolicyType

A value of the CLFS_MGMT_POLICY_TYPE enumeration that identifies the type of policy to be retrieved.

[out] Policy

An instance of the CLFS_MGMT_POLICY structure that contains the policy.

[out] PolicyLength

The length of the Policy parameter.

Return value

The ClfsMgmtQueryPolicy routine returns one of the following NTSTATUS values:

Return code Description
STATUS_SUCCESS
 CLFS management has retrieved the requested policy.
STATUS_UNSUCCESSFUL
 CLFS management was not able to process the request.
STATUS_INVALID_PARAMETER
 The value of the PolicyType parameter is not valid for the CLFS_MGMT_POLICY_TYPE enumeration.
STATUS_INVALID_PARAMETER_1
 A NULL value was supplied for the LogFile parameter.
STATUS_INVALID_PARAMETER_2
 The value of the PolicyLength parameter is less than the size of an instance of the CLFS_MGMT_POLICY structure.
STATUS_INSUFFICIENT_RESOURCES
 There is insufficient memory to complete the operation.
STATUS_LOG_POLICY_NOT_INSTALLED
 No policy of this type has been registered for the log file.
 

This routine might also return other NTSTATUS Values.

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

See also

CLFS_MGMT_POLICY

CLFS_MGMT_POLICY_TYPE