Custom Properties

Provide parameters for the custom input format.

C++ Syntax

HRESULT STDMETHODCALLTYPE put_propertyName(IN VARIANT *value);

Script Syntax

put_propertyName(value);

Parameters

value

A VT_BSTR VARIANT containing the string parameter value specified with the -iCOMParams parameter of the COM input format.

Return Value

Remarks

• Custom properties can only be exposed by custom input formats that implement the IDispatch (Automation) interface. These are usually custom input formats developed as scriptlets (.wsc files) written in JScript or VBScript.
• Custom properties exposed by a custom input format can be set in two different ways:
  • With the Log Parser command-line executable, custom properties can be set through the -iCOMParams parameter of the COM input format, as shown in the following example:

    C:\>LogParser "SELECT * FROM file.txt" -i:COM -iProgID:MySample.CustomInputFormat -iCOMParams:property1=value1,property2=value2
    

  • With the Log Parser scriptable COM components, custom properties can be set directly on the custom input format object before specifying the object as an argument to the Execute or ExecuteBatch methods of the LogQuery object, as shown in the following JScript example:

    var objLogQuery = new ActiveXObject("MSUtil.LogQuery");
    
    // Create custom input format object
    var objCustomInputFormat = new ActiveXObject("MySample.CustomInputFormat");
    
    // Set custom input format parameters
    objCustomInputFormat.property1 = "value1";
    objCustomInputFormat.property2 = "value2";
    
    // Execute query
    var objRecordSet = objLogQuery.Execute("SELECT * FROM file.txt", objCustomInputFormat);
    

Examples

VBScript example:

Function put_extendedFields(strValue)

	If UCase(strValue) = "ON" Then
		m_bExtendedFields = True
	Else
		m_bExtendedFields = False
	End If

End Function

See also:

© 2004 Microsoft Corporation. All rights reserved.