Skip to content

Latest commit

 

History

History
136 lines (92 loc) · 3.04 KB

ns-oaidl-funcdesc.md

File metadata and controls

136 lines (92 loc) · 3.04 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:oaidl.tagFUNCDESC
FUNCDESC (oaidl.h)
Describes a function. (FUNCDESC)
*LPFUNCDESC
FUNCDESC
FUNCDESC structure [Automation]
LPFUNCDESC
LPFUNCDESC structure pointer [Automation]
_oa96_FUNCDESC
automat.funcdesc
oaidl/FUNCDESC
oaidl/LPFUNCDESC
automat\funcdesc.htm
automat
9998e0cb-5aa3-4cd8-86eb-34760eb1164e
12/05/2018
*LPFUNCDESC, FUNCDESC, FUNCDESC structure [Automation], LPFUNCDESC, LPFUNCDESC structure pointer [Automation], _oa96_FUNCDESC, automat.funcdesc, oaidl/FUNCDESC, oaidl/LPFUNCDESC
oaidl.h
Windows
Windows
FUNCDESC, *LPFUNCDESC
19H1
tagFUNCDESC
oaidl/tagFUNCDESC
LPFUNCDESC
oaidl/LPFUNCDESC
FUNCDESC
oaidl/FUNCDESC
c++
APIRef
kbSyntax
HeaderDef
OaIdl.h
FUNCDESC

FUNCDESC structure

-description

Describes a function.

-struct-fields

-field memid

The function member ID.

-field lprgscode

The status code.

-field lprgelemdescParam

Description of the element.

-field funckind

Indicates the type of function (virtual, static, or dispatch-only).

-field invkind

The invocation type. Indicates whether this is a property function, and if so, which type.

-field callconv

The calling convention.

-field cParams

The total number of parameters.

-field cParamsOpt

The number of optional parameters.

-field oVft

For FUNC_VIRTUAL, specifies the offset in the VTBL.

-field cScodes

The number of possible return values.

-field elemdescFunc

The function return type.

-field wFuncFlags

The function flags. See FUNCFLAGS.

-remarks

The cParams field specifies the total number of required and optional parameters.

The cParamsOpt field specifies the form of optional parameters accepted by the function, as follows:

  • A value of 0 specifies that no optional arguments are supported.
  • A value of –1 specifies that the method's last parameter is a pointer to a safe array of variants. Any number of variant arguments greater than cParams –1 must be packaged by the caller into a safe array and passed as the final parameter. This array of optional parameters must be freed by the caller after control is returned from the call.
  • Any other number indicates that the last n parameters of the function are variants and do not need to be specified by the caller explicitly. The parameters left unspecified should be filled in by the compiler or interpreter as variants of type VT_ERROR with the value DISP_E_PARAMNOTFOUND.