InitVariantFromDispatch function (propvarutil.h)

Initializes a VARIANT structure based on an instance of an IDispatch object.

Syntax

HRESULT InitVariantFromDispatch(
  [in]  IDispatch *pdisp,
  [out] VARIANT   *pvar
);

Parameters

[in] pdisp

Type: IDispatch*

Pointer to the source IDispatch.

[out] pvar

Type: VARIANT*

When this function returns, contains the initialized VARIANT structure.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Creates a VT_DISPATCH variant.

This is an inline function, with its source code provided in the header. It is not included in any .dll or .lib file.

Examples

The following example, to be included as part of a larger program, demonstrates how to use InitVariantFromDispatch.

// IDispatch *pDispatch;
// Assume variable pDispatch is initialized and valid.
VARIANT var;

HRESULT hr = InitVariantFromDispatch(pDispatch, &var);

if (SUCCEEDED(hr))
{
    // var now is valid and has type VT_DISPATCH.
    VariantClear(&propvar);
}

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	propvarutil.h
Redistributable	Windows Desktop Search (WDS) 3.0