IPrintOemUI::CommonUIProp メソッド (prcomoem.h)

  • [アーティクル]

IPrintOemUI::CommonUIPropメソッドを使用すると、ユーザー インターフェイス プラグインで既存のプリンター プロパティ シート ページを変更できます。

構文

HRESULT CommonUIProp(
  DWORD         dwMode,
  POEMCUIPPARAM pOemCUIPParam
);

パラメーター

dwMode

変更するプロパティ シート ページを示す呼び出し元指定の整数定数。 次の定数が有効です。

値 定義
OEMCUIP_DOCPROP メソッドは、ドキュメント プロパティ シートの [レイアウト]、[用紙/品質]、または [詳細設定] ページを変更するために呼び出されています。
OEMCUIP_PRNPROP メソッドは、プリンター プロパティ シートの [デバイスの設定] ページを変更するために呼び出されています。

pOemCUIPParam

OEMCUIPPARAM 構造体への呼び出し元が指定したポインター。

戻り値

メソッドは、次のいずれかの値を返す必要があります。

リターン コード 説明
S_OK
 操作が成功しました。
E_FAIL
 操作が失敗しました。
E_NOTIMPL
 このメソッドは実装されていません。

注釈

ユーザー インターフェイス プラグインの メソッドが呼び出されると、既存の IPrintOemUI::CommonUIProp プリンター プロパティ シート ページを変更するために、カスタマイズされたプロパティ シート オプション項目を返す必要があります。

メソッドは IPrintOemUI::CommonUIProp 、プリンター ドライバーの プリンター インターフェイス DLL によって呼び出されます。 メソッドは、オプション値に対するユーザー変更を処理するためのコールバック関数と共に、プロパティ シート項目を記述する OPTITEM 構造体の配列を指定する必要があります。

メソッドは、プロパティ シートごとに 2 回呼び出される必要があります。 メソッドの dwMode パラメーター値は、プリンター プロパティ シートまたはドキュメント プロパティ シートを変更するために呼び出されるかどうかを示します。

メソッドが初めて呼び出されるときは、追加する OPTITEM 構造体の数を返すだけです。 この番号は、 OEMCUIPPARAM 構造体の cOEMOptItems メンバーに配置する必要があります。 プリンター インターフェイス DLL は、指定した数の OPTITEM を格納するのに十分なメモリを割り当ててから、もう一度を呼び出します IPrintOemUI::CommonUIProp 。

2 回目の呼び出し時に、 メソッドは IPrintOemUI::CommonUIProp 次の操作を行う必要があります。

  • OPTITEM 構造体のドライバー指定の配列にオプションの説明を入力します。 この配列は OEMCUIPPARAM 構造体の pOEMOptItems メンバーによって指され、割り当てられた配列要素の数は構造体の cOEMOptItems メンバーに含まれています。 (OPTITEM メンバー値の指定については、OEMCUIPPARAM 構造体の pOEMOptItems メンバーの説明を参照してください)。
  • OEMCUIPPARAM 構造体の cOEMOptItems メンバーに数値を配置して、OPTITEM 配列に追加された構造体の数を返します。
  • OEMCUIPPARAM 構造体の OEMCUIPCallback メンバーのコールバック関数のアドレスを返します。 このコールバック関数は、ユーザーがプロパティ シート ページを変更したときに呼び出されます。 コールバック関数は OEMCUIPCALLBACK 型である必要があります。
  • 必要に応じて、OEMCUIPPARAM 構造体の pOEMUserData メンバーに配置して、プライベート データ構造のアドレスを返します。 構造体の OEMCUIPCallback メンバーによって指定されたコールバック関数は、OEMCUIPPARAM 構造体のアドレスを入力パラメーターとして受け取るため、プライベート データのアドレスを取得できます。

    プライベート データ構造の領域は、OEMCUIPPARAM 構造体の hOEMHeap メンバーに含まれるハンドルを使用して、Microsoft Windows SDK HeapAlloc 関数を呼び出すことによって割り当てる必要があります。

メソッドが複数のユーザー インターフェイス プラグインによってエクスポートされる場合 IPrintOemUI::CommonUIProp 、インストール用にプラグインを指定した順序でメソッドが呼び出されます。

詳細については、「 Driver-Supplied プロパティ シート ページの変更」を参照してください。

要件

要件 値
対象プラットフォーム デスクトップ
Header prcomoem.h (Prcomoem.h を含む)