ITypeLib::GetDocumentation

HRESULT GetDocumentation( 
  int  index,                          
  BSTR FAR*  pBstrName,                
  BSTR FAR*  pBstrDocString,           
  unsigned long FAR*  pdwHelpContext,  
  BSTR FAR*  pBstrHelpFile             
);

Retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic in the Help file.

Parameters

index: Index of the type description whose documentation is to be returned. I If index is–1, then the documentation for the library itself is returned.
pBstrName: Returns a BSTR that contains the name of the specified item. If the caller does not need the item name, then pBstrName can be Null.
pBstrDocString: Returns a BSTR that contains the documentation string for the specified item. If the caller does not need the documentation string, then pBstrDocString can be Null.
pdwHelpContext: Returns the Help context identifier (ID) associated with the specified item. If the caller does not need the Help context ID, then pdwHelpContext can be Null.
pBstrHelpFile: Returns a BSTR that contains the fully qualified name of the Help file. If the caller does not need the Help file name, then 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.
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

The caller should free the BSTR parameters pBstrName, pBstrDocString, and pBstrHelpFile.

Example

for (i = 0; i < utypeinfoCount; i++)
{
    CHECKRESULT(ptlib->GetDocumentation(i, &bstrName, NULL, NULL, NULL));
.
.
.
    SysFreeString(bstrName);
}