ITypeInfo::GetDocumentation

HRESULT GetDocumentation( 
  MEMBERID  memid,                     
  BSTR FAR*  pBstrName,                
  BSTR FAR*  pBstrDocString,           
  unsigned long FAR*  pdwHelpContext,  
  BSTR FAR*  pBstrHelpFile             
);

Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description.

Parameters

memid: ID of the member whose documentation is to be returned.
pBstrName: Pointer to a BSTR allocated by the callee into which the name of the specified item is placed. If the caller does not need the item name, pBstrName can be Null.
pBstrDocString: Pointer to a BSTR into which the documentation string for the specified item is placed. If the caller does not need the documentation string, pBstrDocString can be Null.
pdwHelpContext: Pointer to the Help context associated with the specified item. If the caller does not need the Help context, the pdwHelpContext can be Null.
pBstrHelpFile: Pointer to a BSTR into which the fully qualified name of the Help file is placed. If the caller does not need the Help file name, pBstrHelpFile can be Null.

Return Value

The return value obtained from the returned HRESULT is one of the following:

Return value	Meaning
S_OK	Success.
E_OUTOFMEMORY	Out of memory.
E_INVALIDARG	One or more of the arguments is invalid.
TYPE_E_IOERROR	The function could not read from the file.
TYPE_E_ELEMENTNOTFOUND	The element was not found.
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.
TYPE_E_ELEMENTNOTFOUND	The element was not found.

Comments

The function GetDocumentation provides access to the documentation for the member specified by the memid parameter. If the passed-in memid is MEMBERID_NIL, then the documentation for the type description is returned.

If the type description inherits from another type description, this function is recursive to the base type description, if necessary, to find the item with the requested member ID.

The caller should use SysFreeString() to free the BSTRs referenced by pBstrName, pBstrDocString, and pBstrHelpFile.

Example

CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName, NULL, NULL, 
    NULL));
.
.
.
SysFreeString (bstrName);