IPrintOemUI2::HideStandardUI メソッド (prcomoem.h)

  • [アーティクル]

IPrintOemUI2::HideStandardUIメソッドを使用すると、ユーザー インターフェイス プラグインで標準プロパティ シートを表示するか非表示にするかを指定できます。 Microsoft Windows XP 以降、このメソッドは Pscript5 ユーザー インターフェイス プラグインによって実装できます。 Windows Vista 以降では、このメソッドは Unidrv ユーザー インターフェイス プラグインによって実装できます。

構文

HRESULT HideStandardUI(
  DWORD dwMode
);

パラメーター

dwMode

非表示にするプロパティ シート UI の種類 (ドキュメント プロパティ シートまたはデバイス プロパティ シート) を指定します。 このパラメーターは、printoem.h で定義されている次の定数のいずれかに設定する必要があります。

値 意味
OEMCUIP_DOCPROP 標準のドキュメント プロパティ シート UI を非表示にします。
OEMCUIP_PRNPROP 標準のデバイス プロパティ シート UI を非表示にします。

戻り値

成功すると、このメソッドはS_OKを返す必要があります。 それ以外の場合は、E_NOTIMPLを返す必要があります。 詳細については、「解説」を参照してください。

注釈

このメソッドは、Pscript 5 および Unidrv プラグインの場合は Windows Vista、Pscript5 プラグインの場合は Windows XP でのみサポートされています。

pPSUIInfo--->Reason が PROPSHEETUI_REASON_INIT に設定されている場合、DrvDocumentPropertySheets または DrvDevicePropertySheets DDI 内で、ドライバーは メソッドを呼び出IPrintOemUI2::HideStandardUIして UI プラグインにユーザー インターフェイス要求について尋ねます。 このメソッドは、次の 4 つの方法のいずれかで応答できます。

  1. 標準のドキュメント プロパティ シート UI を非表示にします。
  2. 標準のデバイス プロパティ シート UI を非表示にします。
  3. すべての標準プロパティ シート UI を非表示にします。
  4. 標準のプロパティ シート UI を非表示にしないでください。
次の表は、これらの各状況で メソッドがどのように応答するかを IPrintOemUI2::HideStandardUI まとめたものです。
この応答を示す... IPrintOemUI2::HideStandardUI returns...
標準のドキュメント プロパティ シート UI を非表示にします。 プラグインは、独自のドキュメント プロパティ シート UI を実装します。 dwMode == OEMCUIP_DOCPROP場合は、S_OKを返します。それ以外の場合は、E_NOTIMPLを返します。
標準のデバイス プロパティ シート UI を非表示にします。 プラグインは、独自のデバイス プロパティ シート UI を実装します。 dwMode == OEMCUIP_PRNPROP場合は、S_OKを返します。それ以外の場合は、E_NOTIMPLを返します。
すべての標準プロパティ シート UI を非表示にします。 プラグインは、独自のドキュメント プロパティ シートとデバイス プロパティ シート UI を実装します。 dwMode の値に関係なく、S_OKを返します。
すべての標準プロパティ シート UI を表示します。 dwMode の値に関係なく、E_NOTIMPLを返します。
 

メソッドが IPrintOemUI2::HideStandardUI 、すべての標準プロパティ シートを非表示にする必要があることをドライバーに示す場合、ドライバーは標準プロパティ シートを追加するために compstui.dll ( Pscript コンポーネントを参照) の呼び出しを省略します。 UI プラグインは、S_OKを返す場合 IPrintOemUI2::HideStandardUI 、少なくとも 1 つのカスタム プロパティ シート UI を実装する必要があります。

プリンターに複数の UI プラグインがインストールされている場合、ドライバーはインストールされた順序で UI プラグインを呼び出します。その 1 つがS_OKを返すまで、またはすべての UI プラグインが呼び出され、どの UI プラグインもS_OK返されないまで呼び出されます。 前者のケースは、標準のプロパティ シート UI を非表示にする必要があることをドライバーに示します。 後者の場合は、標準のプロパティ シート UI を表示する必要があることをドライバーに示します。

要件

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

こちらもご覧ください

DrvDevicePropertySheets

DrvDocumentPropertySheets

IPrintOemUI2