3.7.4.8 ITypeInfo::GetDocumentation (Opnum 12)

  • Article

The GetDocumentation method retrieves the documentation resources associated with a type member.

 HRESULT GetDocumentation(
   [in] MEMBERID memid,
   [in] DWORD refPtrFlags,
   [out] BSTR* pBstrName,
   [out] BSTR* pBstrDocString,
   [out] DWORD* pdwHelpContext,
   [out] BSTR* pBstrHelpFile
 );

memid: MUST be either the MEMBERID of a method or data member in the binding context of the ITypeInfo server (see section 3.5.4.1.1), or MEMBERID_NIL (see section 2.2.35.1).

refPtrFlags: MUST be a combination of the bit flags specified in the following table, or 0.

Value

Meaning

TYPEINFO_NameArg

0x00000001

MUST specify that the client is interested in the actual pBstrName [out] argument.

TYPEINFO_DocStringArg

0x00000002

MUST specify that the client is interested in the actual pBstrDocString [out] argument.

TYPEINFO_HelpContextArg

0x00000004

MUST specify that the client is interested in the actual pdwHelpContext [out] argument.

TYPEINFO_HelpFileArg

0x00000008

MUST specify that the client is interested in the actual pBstrHelpFile [out] argument.

pBstrName: If the TYPEINFO_NameArg bit flag is set in refPtrFlags,pBstrName MUST be set to a BSTR that contains the name of the type or specified type member. Othernwise, pBstrName MUST be set to a NULL BSTR.

pBstrDocString: MUST be set to the documentation string that was associated with the type or specified type member using the [helpstring] attribute (see section 2.2.49.2), if the TYPEINFO_DocStringArg bit flag is set in refPtrFlags. MAY be set to an implementation-specific string<59> if no [helpstring] attribute is specified. MUST be set to a NULL BSTR otherwise.

pdwHelpContext: MUST be set to the value that was associated with the type or specified type member using the [helpcontext] attribute (see section 2.2.49.2), if the TYPEINFO_HelpContextArg bit flag is set in refPtrFlags. MUST be set to 0 otherwise.

pBstrHelpFile: MUST be set to the documentation string that was associated with the type or specified type member using the [helpfile] attribute (see section 2.2.49.2), if the TYPEINFO_HelpFileArg bit flag is set in refPtrFlags. MUST be set to a NULL BSTR otherwise.

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, the method failed and encountered a fatal error.

If memid is MEMBERID_NIL, the values of pBstrName, pBstrDocString, pdwHelpContext, and pBstrHelpFile MUST correspond to the attributes declared with the type, as specified in section 2.2.49.3. Otherwise, they MUST correspond to the attributes declared with the specified member of the type.