ITypeInfo2::GetDocumentation2

This method retrieves the documentation string and other Help-related information.

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

Parameters

  • memid
    Member identifier for the type description.
  • lcid
    Locale identifier (LCID).
  • pbstrHelpString
    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
    Returns a pointer to the Help localization context. If the caller does not need the Help context, it can be NULL.
  • pbstrHelpStringDll
    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 Values

One of the values described in the following table is returned.

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 GetDocumentation method and return the associated documentation string.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS        

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.