ITypeLib2::GetDocumentation2

HRESULT GetDocumentation2( 
  [in] int  index,                                 
  [in] LCID  lcid,                                 
  [out] BSTR FAR*  pbstrHelpString,                
  [out] unsigned long FAR*  pdwHelpStringContext,  
  BSTR FAR*  pbstrHelpStringDll                    
);

Retrieves the library's documentation string, the complete Help file name and path, the localization context to use, and the context ID for the library Help topic in the Help file.

Parameters

index: Index of the type description whose documentation is to be returned; if index is
–1, then the documentation for the library is returned.
lcid: Locale identifier.
pbstrHelpString: Returns a BSTR that contains the name of the specified item. If the caller does not need the item name, then pbstrHelpString can be Null.
pdwHelpStringContext: Returns the Help localization context. If the caller does not need the Help context, then it can be Null.
pbstrHelpStringDll: Returns a BSTR that contains the fully qualified name of the file containing the DLL used for Help file. If the caller does not need the file name, then it can be Null.

Return Value

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

Return value	Meaning
S_OK	Success.
STG_E_INSUFFICIENTMEMORY	Out of memory.
E_INVALIDARG	One or more of the arguments is invalid.
TYPE_E_IOERROR	The function could not write to the file.
TYPE_E_INVDATAREAD	The function could not read from the file.
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

Gets information at the type library level. The caller should free the BSTR parameters.

This function will call _DLLGetDocumentation in the specified DLL to retrieve the desired Help string, if there is a Help string context for this item. If no Help string context exists or an error occurs, then it will defer to the GetDocumentation method and return the associated documentation string.