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


Метод CWiauPropertyList::D efineProperty (wiautil.h)

Метод CWiauPropertyList::D efineProperty добавляет определение свойства в объект списка свойств.

Синтаксис

HRESULT DefineProperty(
  int      *pIdx,
  PROPID   PropId,
  LPOLESTR PropName,
  ULONG    Access,
  ULONG    SubType
);

Параметры

pIdx

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

PropId

Задает константу идентификатора свойства.

PropName

Указатель на строку имени свойства.

Access

Указывает тип доступа для свойства, обычно WIA_PROP_READ (только для чтения) или WIA_PROP_RW (чтение и запись).

SubType

Указывает подтип свойства, один из WIA_PROP_FLAG, WIA_PROP_LIST, WIA_PROP_RANGE или WIA_PROP_NONE. Первые три константы указывают, соответственно, что свойство является набором значений флагов, списком значений или диапазоном значений. Четвертая константа указывает, что свойство не является ни одной из них.

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

Этот метод возвращает S_OK, если он может успешно определить свойство. Если в списке свойств недостаточно места для дополнительного свойства, метод возвращает E_FAIL.

Комментарии

Перед добавлением свойства в список свойств необходимо инициализировать список свойств. Для этого вызовите метод CWiauPropertyList::Init .

Требования

Требование Значение
Целевая платформа Персональный компьютер
Верхняя часть wiautil.h (включая Wiautil.h, Wiamindr.h)

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

CWiauPropertyList

CWiauPropertyList::Init