PropertyObject.GetValIDispatch

Syntax

PropertyObject.GetValIDispatch( lookupString, options)

Return Value

Object

IDispatch pointer value of the property.

Purpose

Returns the value of the ActiveX Automation Reference property the lookupString parameter specifies. The object is returned as an IDispatch pointer.

Remarks

This method returns a NULL reference, if that is what the property contains.

Note This method and the PropertyObject.GetValInterface method apply to the PropValType_Reference value type. The PropertyObject.GetValInterface and PropertyObject.SetValInterface methods are meant for advanced users who want to store arbitrary interfaces in TestStand reference properties.

Parameters

lookupString As String

[In] Pass an empty string to denote the PropertyObject to which the method applies, or pass the name of a subproperty within the PropertyObject. You can also pass lookup strings to this parameter.

options As Long

[In] Pass 0 to specify the default behavior, or pass one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.

Example

LabWindows/CVI:     CAObjHandle tmpObj = 0;     TS_PropertyGetValIDispatch(propObj, &errorInfo,                                "Locals.ActiveXAutoObj", 0, &tmpObj);     CA_DiscardObjHandle(tmpObj); Visual Basic (function call):     Dim tmpObj As Object     Set tmpObj = propObj.GetValIDispatch("Locals.ActiveXAutoObj", 0) Visual Basic (inline):     Dim tmpObj As Object     Set tmpObj = propObj.Locals.ActiveXAutoObj Visual C++:     LPDISPATCH tmpObjPtr = NULL;     tmpObjPtr = propObj->GetValIDispatch("Locals.ActiveXAutoObj", 0);     if (tmpObjPtr)          tmpObjPtr->Release();

See Also

Lookup Strings

PropertyObject.GetValIDispatchByOffset

PropertyObject.GetValInterface

PropertyObject.SetValIDispatch

PropertyOptions

PropertyValueTypes

Thread Safety of the PropertyObject API and TestStand Variables