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

Метод ICreateTypeInfo::SetFuncDocString (oaidl.h)

  • Статья

Задает строку документации для функции с указанным индексом.

Синтаксис

HRESULT SetFuncDocString(
  [in] UINT     index,
  [in] LPOLESTR szDocString
);

Параметры

[in] index

Индекс функции.

[in] szDocString

Строка документации.

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

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

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

Комментарии

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

Требования

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

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

ICreateTypeInfo