Skip to content

Latest commit

 

History

History
133 lines (107 loc) · 3.31 KB

nf-oaidl-itypeinfo-getfuncdesc.md

File metadata and controls

133 lines (107 loc) · 3.31 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
NF:oaidl.ITypeInfo.GetFuncDesc
ITypeInfo::GetFuncDesc (oaidl.h)
Retrieves the FUNCDESC structure that contains information about a specified function.
GetFuncDesc
GetFuncDesc method [Automation]
GetFuncDesc method [Automation]
ITypeInfo interface
ITypeInfo interface [Automation]
GetFuncDesc method
ITypeInfo.GetFuncDesc
ITypeInfo::GetFuncDesc
_oa96_ITypeInfo_GetFuncDesc
automat.itypeinfo_getfuncdesc
oaidl/ITypeInfo::GetFuncDesc
automat\itypeinfo_getfuncdesc.htm
automat
1e3331a2-0156-4d8f-aa7f-e32cecd3eb74
12/05/2018
GetFuncDesc, GetFuncDesc method [Automation], GetFuncDesc method [Automation],ITypeInfo interface, ITypeInfo interface [Automation],GetFuncDesc method, ITypeInfo.GetFuncDesc, ITypeInfo::GetFuncDesc, _oa96_ITypeInfo_GetFuncDesc, automat.itypeinfo_getfuncdesc, oaidl/ITypeInfo::GetFuncDesc
oaidl.h
Windows
OaIdl.idl
Windows
19H1
ITypeInfo::GetFuncDesc
oaidl/ITypeInfo::GetFuncDesc
c++
APIRef
kbSyntax
COM
oaidl.h
ITypeInfo.GetFuncDesc

ITypeInfo::GetFuncDesc

-description

Retrieves the FUNCDESC structure that contains information about a specified function.

-parameters

-param index [in]

The index of the function whose description is to be returned. The index should be in the range of 0 to 1 less than the number of functions in this type.

-param ppFuncDesc [out]

A FUNCDESC structure that describes the specified function.

-returns

This method can return one of these values.

Return code Description
S_OK
Success.
E_INVALIDARG
One or more of the arguments is not valid.
E_OUTOFMEMORY
Insufficient memory to complete the operation.

-remarks

The function ITypeInfo::GetFuncDesc provides access to a FUNCDESC structure that describes the function with the specified index. The FUNCDESC structure should be freed with ITypeInfo::ReleaseFuncDesc. The number of functions in the type is one of the attributes contained in the TYPEATTR structure.

Examples

In the following example, the CHECKRESULT function is undefined. Replace this function with your error handling code.

CHECKRESULT(ptypeinfo->GetFuncDesc(i, &pfuncdesc));
idMember = pfuncdesc->memid;
CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName, NULL, NULL, NULL));
ptypeinfo->ReleaseFuncDesc(pfuncdesc);

-see-also

ITypeInfo