 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This method retrieves the FUNCDESCstructure that contains information about a specified function.
HRESULT GetFuncDesc( unsigned int index , FUNCDESC FAR *FAR * ppFuncDesc );
Parameters
- index
- Index of the function whose description is to be returned. The indexshould be in the range of 0 to 1 less than the number of functions in this type.
- ppFuncDesc
- On return, pointer to a pointer to a
FUNCDESCthat describes the specified function.
Return Values
One of the values described in the following table is returned.
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 GetFuncDescprovides access to a FUNCDESCstructure that describes the function with the specified index. The FUNCDESCshould be freed with ITypeInfo::ReleaseFuncDesc. The number of functions in the type is one of the attributes contained in the TYPEATTRstructure.
Example
CHECKRESULT(ptypeinfo->GetFuncDesc(i, &pfuncdesc)); idMember = pfuncdesc->elemdescFunc.ID; CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName, NULL, NULL, NULL)); ptypeinfo->ReleaseFuncDesc(pfuncdesc);
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 2.0 and later Oaidl.h Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.