EnableLogging Property of the IFPCPolicyRule Interface

Article
08/13/2010

The EnableLogging property gets or sets a Boolean value that indicates whether the rule is enabled for logging.

C++

HRESULT put_EnableLogging(
    VARIANT_BOOL fEnableLogging
);
HRESULT get_EnableLogging(
    VARIANT_BOOL* pfEnableLogging
);

Parameters

fEnableLogging
Boolean value that indicates whether the rule is enabled for logging.
pfEnableLogging
Pointer to a Boolean variable that is set on return to VARIANT_TRUE if the rule is enabled for logging, or to VARIANT_FALSE if the rule is not enabled for logging.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Visual Basic

Property EnableLogging As Boolean

Property Value

Boolean value that indicates whether the rule is enabled for logging.

Remarks

This property is read/write. Its default value is True (VARIANT_TRUE in C++).

When a rule is enabled for logging, all client requests that match the rule are recorded in the applicable log. However, a for Web publishing rule, this property applies only to the Web proxy log, and all traffic arriving on port 80 is recorded in the Firewall service log.

This property can be used to enable or disable logging for a system policy rule. For a VBScript code example that disables logging for all system policy rules defined in the containing array, see the reference page for the PolicyRules property of the FPCSystemPolicy object.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.
DLL	Requires Msfpccom.dll.

Share via