Share this page

# lrc_DispPropertyGet

IDispatch Interface Calls

Gets a property using the IDispatch interface.

    VARIANT lrc_DispPropertyGet( IDispatch * pDispatch, char *idName, unsigned long locale, ...);

*pDispatch | A pointer to the IDispatch interface.
*idName | A pointer to the name of the property.
locale | The language locale.

The lrc_DispPropertyGet Additional Arguments

LAST_ARG | A flag signaling that the preceding argument was the last argument.
__CheckResult | This flag is generated by VuGen to indicate if the call was successful when the script was generated and HRESULT should be checked. Values: CHECK_HRES or DONT_CHECK_HRES.

The lrc_DispPropertyGet call gets a property using the IDispatch interface and sets wflags to DISPATCH_PROPERTYGET.

Calls to IDispatch:Invoke from VuGen scripts are implemented using lrc_Disp functions. These calls are constructed somewhat differently from calls to other interfaces. Calls to GetIDsOfNames are hidden inside the lrc_Disp calls. Each lrc_Disp call sets a different wflags parameter value when it calls IDispatch:Invoke.

IDispatch is a "meta-interface" that exposes all of the other interfaces and methods of a COM object.

## Return Values

lrc Return Values

## Parameterization

You cannot use standard parameterization for any arguments in this function.

## Example

This example shows how to use lrc_PropertyGet to retrieve an array of strings.

    VARIANT retValue;
    retValue = lrc_variant_empty();
    retValue = lrc_DispPropertyGet((IDispatch*)IDispatch_0, "AgentsArray", /*locale*/1033, LAST_ARG, CHECK_HRES);

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: