IFPCPolicyRule::EnableLogging property

Article
08/27/2012

Applies to: desktop apps only

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

This property is read/write.

Syntax

HRESULT put_EnableLogging(
  VARIANT_BOOL fEnableLogging
);

HRESULT get_EnableLogging(
  VARIANT_BOOL *pfEnableLogging
);

' Data type: Boolean

Property EnableLogging( _
  ByVal fEnableLogging As VARIANT_BOOL, _
  ByVal pfEnableLogging As VARIANT_BOOL _
) As Boolean

Property value

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

Error codes

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

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

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll