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

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

  • Статья

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

Синтаксис

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

Параметры

[in] memid

Идентификатор элемента, для которого возвращается документация.

[out] pBstrName

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

[out] pBstrDocString

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

[out] pdwHelpContext

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

[out] pBstrHelpFile

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

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

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

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

Комментарии

Функция GetDocumentation предоставляет доступ к документации для элемента, указанного параметром memid . Если переданный memid MEMBERID_NIL, возвращается документация по описанию типа.

Если описание типа наследуется от другого описания типа, при необходимости эта функция рекурсивно применяется к описанию базового типа, чтобы найти элемент с запрошенным идентификатором элемента.

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

Требования

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

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

ITypeInfo