ITypeLib::GetDocumentation
A version of this page is also available for
4/8/2010
This method retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic.
Syntax
HRESULT GetDocumentation(
int index,
BSTR FAR* pBstrName,
BSTR FAR* pBstrDocString,
unsigned long FAR* pdwHelpContext,
BSTR FAR* pBstrHelpFile
);
Parameters
- index
[in] Index of the type description whose documentation is to be returned. I If index is1, then the documentation for the library itself is returned.
- pBstrName
[out] 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
[out] 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
[out] Returns a pointer to the Help context identifier associated with the specified item. If the caller does not need the Help context identifier, then pdwHelpContext can be NULL.
- pBstrHelpFile
[out] Returns a pointer to 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 following table shows the return values for this function.
| Value | Description |
|---|---|
S_OK |
Success. |
STG_E_INSUFFICIENTMEMORY |
Out of memory. |
E_INVALIDARG |
One or more of the parameters 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. |
Remarks
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);
}
Requirements
| Header | oaidl.h, oaidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |