CWiauPropertyList::D efineProperty 方法 (wiautil.h)

CWiauPropertyList::D efineProperty 方法将属性定义添加到属性列表对象。

语法

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

参数

pIdx

指向接收新添加属性索引的内存位置的指针。 此类中的许多其他方法使用属性的索引来标识属性。

PropId

指定属性 ID 常量。

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