Метод ITypeLib::GetDocumentation (oaidl.h)

Извлекает строку документации для библиотеки, полное имя и путь к файлу справки, а также идентификатор контекста для раздела справки библиотеки в файле справки.

Синтаксис

HRESULT GetDocumentation(
  [in]  INT   index,
  [out] BSTR  *pBstrName,
  [out] BSTR  *pBstrDocString,
  [out] DWORD *pdwHelpContext,
  [out] BSTR  *pBstrHelpFile
);

Параметры

[in] index

Индекс описания типа, для которого возвращается документация. Если индекс равен -1, возвращается документация для самой библиотеки.

[out] pBstrName

Имя указанного элемента. Если вызывающей объекту имя элемента не требуется, значение pBstrName может иметь значение NULL.

[out] pBstrDocString

Строка документации для указанного элемента. Если вызывающей строке документации не требуется, pBstrDocString может иметь значение null..

[out] pdwHelpContext

Идентификатор контекста справки, связанный с указанным элементом. Если вызывающему объекту не требуется идентификатор контекста справки, то pdwHelpContext может иметь значение NULL.

[out] pBstrHelpFile

Полное имя файла справки. Если вызывающему объекту не требуется имя файла справки, pBstrHelpFile может иметь значение NULL.

Возвращаемое значение

Этот метод может возвращать одно из этих значений.

Код возврата	Описание
S_OK	Успешно.
E_INVALIDARG	Один или несколько аргументов недопустимы.
STG_E_INSUFFICIENTMEMORY	Недостаточно памяти для завершения операции.

Комментарии

Вызывающий объект должен освободить параметры pBstrName, pBstrDocString и pBstrHelpFile.

Требования

Требование	Значение
Целевая платформа	Windows
Header	oaidl.h

См. также раздел

ITypeLib