This method retrieves the FUNCDESC structure that contains information about a specified function.
HRESULT GetFuncDesc( unsigned intindex,FUNCDESC FAR* FAR* ppFuncDesc );
Parameters
- index
[in] 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. - ppFuncDesc
[out] On return, pointer to a pointer to a FUNCDESC that describes the specified function.
Return Values
The following table shows the return values for this function.
| Value | Description |
|---|---|
| S_OK | Success. |
| E_OUTOFMEMORY | Out of memory. |
| E_INVALIDARG | One or more of the parameters is invalid. |
| TYPE_E_IOERROR | The function could not read from the file. |
| TYPE_E_INVDATAREAD | Invalid data. |
| TYPE_E_UNSUPFORMAT | The type library has an older format. |
| TYPE_E_INVALIDSTATE | The type library could not be opened. |
Remarks
The function GetFuncDesc provides access to a FUNCDESC structure that describes the function with the specified index. The FUNCDESC should be freed with ITypeInfo::ReleaseFuncDesc. The number of functions in the type is one of the attributes contained in the TYPEATTR structure.
Example
CHECKRESULT(ptypeinfo->GetFuncDesc(i, &pfuncdesc));
idMember = pfuncdesc->elemdescFunc.ID;
CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName, NULL, NULL, NULL));
ptypeinfo->ReleaseFuncDesc(pfuncdesc);
Requirements
OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.
See Also
ITypeInfo | FUNCDESC | ITypeInfo::ReleaseFuncDesc | TYPEATTR
Send Feedback on this topic to the authors