DispGetParam.3w

Langue: en

Version: Jun 2009 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

DispGetParam (OLEAUT32.28)

SYNOPSIS

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.

DESCRIPTION

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

Defined in "oleauto.h".

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

Debug channel "ole".