3.7.4.3 ITypeInfo::GetFuncDesc (Opnum 5)

  • Article

The GetFuncDesc method retrieves a FUNCDESC structure that contains information about a member of the ITypeInfo server's method or dispatch method table.

 HRESULT GetFuncDesc(
   [in] UINT index,
   [out] LPFUNCDESC* ppFuncDesc,
   [out] DWORD* pReserved
 );

index: MUST equal the ordinal position in the method table (if the type describes a DCOM interface or module) or the dispatch method table (if the type describes a dispinterface) of the method whose description is to be returned. The value of index MUST be less than the value of the cFuncs field in the TYPEATTR (section 2.2.44) structure returned by the GetTypeAttr (section 3.7.4.1) method.

ppFuncDesc: MUST be set to a FUNCDESC structure (see section 2.2.42) that contains the data values associated with the specified member of the method or dispatch method table, or NULL if no such member exists.

pReserved: MUST be set to 0 and ignored on receipt.

Return Values: The method MUST return information in an HRESULT data structure, defined in [MS-ERREF] section 2.1. The severity bit in the structure identifies the following conditions:

  • If the severity bit is set to 0, the method completed successfully.

  • If the severity bit is set to 1 and the entire HRESULT DWORD does not match a value in the following table, a fatal failure occurred.

  • If the severity bit is set to 1 and the entire HRESULT DWORD matches a value in the following table, a failure occurred.

    Return value/code

    Description

    0x8002802B

    TYPE_E_ELEMENTNOTFOUND

    The value of index did not specify the ordinal position of an element in the method table.