LogFieldSelectionString Property of the IFPCLog2 Interface

Article
08/13/2010

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.

C++

HRESULT put_LogFieldSelectionString(
    BSTR bstrLogFieldSelectionString
);
HRESULT get_LogFieldSelectionString(
    BSTR* pbstrLogFieldSelectionString
);

Parameters

bstrLogFieldSelectionString
BSTR that specifies a string in which each character specifies whether a particular log field is selected for logging.
pbstrLogFieldSelectionString
Pointer to a BSTR that is set on return to a string value specifying a string in which each character specifies whether a particular log field is selected for logging.

Return Value

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

Visual Basic

Property LogFieldSelectionString As String

Property Value

String in which each character specifies whether a particular log field is selected for logging.

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

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.