InstallLogPolicy function (clfsmgmtw32.h)

Installs (sets) a policy for a log.

Syntax

CLFSUSER_API BOOL InstallLogPolicy(
  [in] HANDLE            hLog,
  [in] PCLFS_MGMT_POLICY pPolicy
);

Parameters

[in] hLog

A handle to a log.

[in] pPolicy

A pointer to a CLFS_MGMT_POLICY structure that represents the desired policy to install.

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

Installing a log policy does not trigger an immediate change in behavior.

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

See also

CLFS_MGMT_POLICY

CLFS_MGMT_POLICY_TYPE

SetLogFileSizeWithPolicy