IFPCLog2::LogFieldSelectionString property

Article
08/27/2012

Applies to: desktop apps only

The LogFieldSelectionString property gets or sets a string in which each character specifies whether a particular log field is selected for logging. The first character refers to the first field defined for the log object, the second bit refers to the second field, and so on. Tables of the Firewall service and Web proxy log fields are provided in Log Fields.

This property is read/write.

Syntax

HRESULT put_LogFieldSelectionString(
  BSTR bstrLogFieldSelectionString
);

HRESULT get_LogFieldSelectionString(
  BSTR *pbstrLogFieldSelectionString
);

' Data type: String

Property LogFieldSelectionString( _
  ByVal bstrLogFieldSelectionString As BSTR, _
  ByVal pbstrLogFieldSelectionString As BSTR _
) As String

Property value

String in which each character specifies whether a particular log field is selected 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. The default string for Firewall service logging is "11111111111110111111000011110000111010000000110", and the default string for Web proxy logging is "11101101111111110111110111111011111111000000000001111111111". In these strings, the character 1 indicates that the applicable field is selected for logging, and the character 0 indicates that the applicable field is not selected for logging.

If the lengfth of the string is less than the number of fields defined for the logging component, the remaining fields are selected automatically. For example, an empty string indicates that all the log fields are selected for logging.

This property supersedes the LogFieldSelection property.

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

Share via