Поделиться через

Метод ITypeInfo2::GetDocumentation2 (oaidl.h)

  • Статья

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

Синтаксис

HRESULT GetDocumentation2(
  [in]  MEMBERID memid,
  [in]  LCID     lcid,
  [out] BSTR     *pbstrHelpString,
  [out] DWORD    *pdwHelpStringContext,
  [out] BSTR     *pbstrHelpStringDll
);

Параметры

[in] memid

Идентификатор элемента для описания типа.

[in] lcid

Код локали.

[out] pbstrHelpString

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

[out] pdwHelpStringContext

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

[out] pbstrHelpStringDll

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

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

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

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

Комментарии

Получает сведения на уровне сведений о типе (сведения о типе и его членах). Вызывающий объект должен освободить параметры BSTR.

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

Требования

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

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

ITypeInfo2