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のいずれかを指定します。 最初の 3 つの定数は、プロパティがフラグ値のセット、値のリスト、または値の範囲であることを示します。 4 番目の定数は、プロパティがこれらのいずれにもないことを示します。

戻り値

このメソッドは、プロパティを正常に定義できる場合は、S_OKを返します。 プロパティ リストに追加のプロパティに十分な空きがない場合、メソッドはE_FAILを返します。

備考

プロパティリストにプロパティを追加するには、プロパティリストを初期化する必要があります。 これを行うには、CWiauPropertyList::Init メソッドを呼び出します。

必要条件

要件	価値
ターゲット プラットフォーム の	デスクトップ
ヘッダー	wiautil.h (Wiautil.h、Wiamindr.h を含む)

関連項目

CWiauPropertyList

CWiauPropertyList::Init