ITypeInfo::GetFuncDesc method (oaidl.h)

Article
02/22/2024

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

Syntax

HRESULT GetFuncDesc(
  [in]  UINT     index,
  [out] FUNCDESC **ppFuncDesc
);

Parameters

[in] index

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.

[out] ppFuncDesc

A FUNCDESC structure that describes the specified function.

Return value

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);

Requirements

Requirement	Value
Target Platform	Windows
Header	oaidl.h

Share via