3.9.4.8 ITypeInfo2::GetVarCustData (Opnum 29)

  • Article

The GetVarCustData method retrieves the value of a custom data item associated with the specified data member.

 HRESULT GetVarCustData(
   [in] UINT index,
   [in] REFGUID guid,
   [out] VARIANT* pVarVal
 );

index: MUST specify an ordinal position in the data member table and MUST be less than the value of the cVars field in the TYPEATTR structure of the associated type, as specified in sections 2.2.44 and 3.7.4.1.

guid: MUST be the GUID associated with the custom data item using the [custom] attribute, as specified in section 2.2.49.5.

pVarVal: MUST be set to the value of the custom data item, or to VT_EMPTY if the type does not have a value associated with the GUID.

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 data member table. See [MS-ERREF].