Метод IPerPropertyBrowsing::GetDisplayString (ocidl.h)

Статья
03/05/2024

Извлекает текстовую строку, описывающую указанное свойство.

Синтаксис

HRESULT GetDisplayString(
  [in]  DISPID dispID,
  [out] BSTR   *pBstr
);

Параметры

[in] dispID

Идентификатор диспетчера свойства, отображаемое имя которого запрашивается.

[out] pBstr

Указатель на переменную, которая получает отображаемое имя свойства, указанного в dispID. Строка выделяется этим методом с помощью SysAllocString. После возврата за строку отвечает вызывающий объект, который должен освободить ее с помощью SysFreeString , когда она больше не нужна.

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

Этот метод может возвращать стандартные возвращаемые значения E_INVALIDARG, E_OUTOFMEMORY и E_UNEXPECTED, а также следующие значения.

Код возврата	Описание
S_OK	Отображаемое имя было успешно возвращено.
E_NOTIMPL	Объект не предоставляет отображаемые имена для отдельных свойств. Вызывающий объект может проверка сведения о типе объекта для текстового имени объекта в этом случае.
E_POINTER	Недопустимый адрес в pbstr. Например, он может иметь значение NULL.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	ocidl.h

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

IPerPropertyBrowsing

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