wiasCreatePropContext 関数 (wiamdef.h)

wiasCreatePropContext 関数は、アプリケーションによって変更されるアイテムのプロパティを示すプロパティ コンテキストを割り当てます。

構文

HRESULT wiasCreatePropContext(
                 ULONG                cPropSpec,
  [in]           PROPSPEC             *pPropSpec,
                 ULONG                cProps,
  [in, optional] PROPID               *pProps,
  [in]           WIA_PROPERTY_CONTEXT *pContext
);

パラメーター

cPropSpec

pPropSpec 配列内の PROPSPEC 構造体の合計数を指定します。

[in] pPropSpec

変更するプロパティを識別する PROPSPEC 構造体の配列の最初の要素へのポインター。

cProps

このコンテキストに格納されているプロパティ識別子の数を指定します。

[in, optional] pProps

このプロパティ コンテキストに配置するプロパティを示すプロパティ識別子の配列の最初の要素へのポインター。

[in] pContext

プロパティ コンテキストを含む WIA_PROPERTY_CONTEXT 構造体へのポインター。

戻り値

成功すると、関数はS_OKを返します。 関数が失敗した場合は、標準の COM エラーまたは WIA エラー コードのいずれかを返します。

注釈

この関数は、プロパティ コンテキストを割り当て、その値を入力します。 この関数は一般に、アプリケーションによって書き込まれたプロパティが検証される wiasValidateItemProperties で使用されます。

プロパティ コンテキストのエントリは、依存関係を持つか、それ自体が他のプロパティに依存しているプロパティの識別子です。 コンテキストは、変更されるプロパティをマークするために使用されます。 プロパティ コンテキストが不要になった場合は、 wiasFreePropContext の呼び出しによって解放する必要があります。

アプリケーションが書き込むプロパティは、 pPropSpec 配列によって指定されます。 アプリケーションによって変更されたプロパティと、変更されたプロパティに依存するプロパティは、 pProps 配列によって指定されます。 pProps では、アプリケーションによって変更されたプロパティ (および依存プロパティ) のみを指定できます。

詳しくは、 PROPSPEC 構造体を参照してください。

ドライバーは、wiasCreatePropContext を使用してプロパティ コンテキストを作成するときに、追加のプロパティを指定できます。

WIA_PROPERTY_CONTEXTには、次のプロパティが常に存在します。

• WIA_IPA_DATATYPE

• WIA_IPA_DEPTH

• WIA_IPS_XRES

• WIA_IPS_XPOS

• WIA_IPS_XEXTENT

• WIA_IPA_PIXELS_PER_LINE

• WIA_IPS_YRES

• WIA_IPS_YPOS

• WIA_IPS_YEXTENT

• WIA_IPA_NUMBER_OF_LINES

• WIA_IPS_CUR_INTENT

• WIA_IPA_TYMED

• WIA_IPA_FORMAT

要件

こちらもご覧ください

WIA_PROPERTY_CONTEXT

wiasFreePropContext

wiasValidateItemProperties