DispGetParam(3w)

DispGetParam3w

Usage

HRESULT DispGetParam
(
DISPPARAMS* pdispparams,
UINT position,
VARTYPE vtTarg,
VARIANT* pvarResult,
UINT* puArgErr
)

Params

pdispparams [In] Parameter list.

position [In] Position of parameter to coerce in pdispparams.

vtTarg [In] Type of value to coerce to.

pvarResult [Out] Destination for resulting variant.

puArgErr [Out] Destination for error code.

Overview

Retrieve a parameter from a DISPPARAMS structure and coerce it to the specified variant type.

Notes

Coercion is done using system (0) locale.

Returns

Success: S_OK.

Failure: DISP_E_PARAMNOTFOUND, if position is invalid. or DISP_E_TYPEMISMATCH, if the coercion failed. puArgErr is set to the index of the argument in pdispparams.

Implementation

Declared in "oleauto.h".

Implemented in "dlls/oleaut32/dispatch.c".

Debug channel "ole".

Releases

4 releases since Debian 4.0 (Etch); the text changed 3 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7

From libwine-dev 1.4.1-4 in Debian 7 (Wheezy). Parsed by carta from the page's man source.