ITypeInfo2::GetDocumentation2
A version of this page is also available for
4/8/2010
This method retrieves the documentation string and other Help-related information.
Syntax
HRESULT GetDocumentation2(
MEMID memid,
LCID lcid,
BSTR FAR* pbstrHelpString,
unsigned long FAR* pdwHelpStringContext,
BSTR FAR* pbstrHelpStringDll
);
Parameters
- memid
[in] Member identifier for the type description.
- lcid
[in] Locale identifiers (LCID).
pbstrHelpString
[out] Returns a pointer to 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
[out] Returns a pointer to the Help localization context.If the caller does not need the Help context, it can be NULL.
pbstrHelpStringDll
[out] Returns a pointer to a BSTR that contains the fully qualified name of the file that contains the DLL used for Help file.If the caller does not need the file name, it 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
Gets information at the type information level (about the type information and its members). 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 ITypeInfo::GetDocumentation method and return the associated documentation string.
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 |