Справочник по технологии COM
Страница 72. ITypeLib2::GetDocumentation2
Страница 72 из 111
 

ITypeLib2::GetDocumentation2

Возвращает строку документации, а также полное путевое имя файла справочной системы и идентификатор контекста для раздела файла справочной системы. 

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

Параметры:
index
Индекс описания типа, для которого возвращается информация; если он равен —1, то возвращается информация для самой библиотеки.
kid
Идентификатор местности.
pbstrHelpString
Возвращается BSTR, содержащая имя соответствующего элемента. Если вызывающему не нужна эта информация, то параметр может иметь значение NULL.
pdwHelpStringContext
Возвращается контекст локализации справочной информации. Если вызывающему не нужна эта информация, то параметр может иметь значение NULL.
pbstrHelpStringDll
Возвращается BSTR, содержащая полное путевое имя файла DLL справочной информации. Если вызывающему не нужна эта информация, то параметр может иметь значение NULL.

Коды возврата:
Из возвращенного HRESULT получают один из следующих кодов возврата:

Код возврата Значение
S_OK Успех.
STG Е INSUFFICIENTMEMORY Не хватает памяти.
E_INVALIDARG Один или несколько аргументов неверны.
TYPE_E_IOERROR Функция не может выполнить запись в файл.
TYPE_E_INVDATAREAD Функция не может читать из файла.
TYPE_E_UNSUPFORMAT Библиотека типа имеет старый формат.
TYPE_E_INVALIDSTATE He удается открыть библиотеку типа.
TYPE_E_ELEMENTNOTFOUND Элемент не найден.

Комментарии:
Возвращает информацию на уровне библиотеки типа. Вызывающий обязан освобождать возвращаемые BSTR.
Если для данного элемента задан контекст строки справочной информации, то для получения нужной строки функция вызывает _DLLGetDocumentation в заданной DLL. Если контекст строки не задан или произошла ошибка, то для получения соответствующей строки документации будет вызван метод GetDocumentation.
 
Следующая статья »