OEMCUIPPARAM 構造体 (printoem.h)

  • [アーティクル]

OEMCUIPPARAM 構造体は、ユーザー インターフェイス プラグインの IPrintOemUI::CommonUIProp メソッドへの入力パラメーターとして使用されます。

構文

typedef struct _OEMCUIPPARAM {
  DWORD           cbSize;
  POEMUIOBJ       poemuiobj;
  HANDLE          hPrinter;
  PWSTR           pPrinterName;
  HANDLE          hModule;
  HANDLE          hOEMHeap;
  PDEVMODE        pPublicDM;
  PVOID           pOEMDM;
  DWORD           dwFlags;
  POPTITEM        pDrvOptItems;
  DWORD           cDrvOptItems;
  POPTITEM        pOEMOptItems;
  DWORD           cOEMOptItems;
  PVOID           pOEMUserData;
  OEMCUIPCALLBACK OEMCUIPCallback;
} *POEMCUIPPARAM, OEMCUIPPARAM;

メンバー

cbSize

OEMCUIPPARAM 構造体のサイズ。 Unidrv または Pscript5 ドライバーによって提供されます。

poemuiobj

OEMUIOBJ 構造体へのポインター。

hPrinter

プリンターへのハンドル。 Unidrv または Pscript5 ドライバーによって提供されます。

pPrinterName

プリンター名を含む文字列。 Unidrv または Pscript5 ドライバーによって提供されます。

hModule

ユーザー インターフェイス プラグインを処理します。 Unidrv または Pscript5 ドライバーによって提供されます。

hOEMHeap

HeapAlloc 関数を呼び出すことによって、領域を割り当てることができるヒープを処理します (Microsoft Windows SDKドキュメントで説明)。 Unidrv または Pscript5 ドライバーによって提供されます。

pPublicDM

プリンターのパブリック DEVMODEW 構造体へのポインター。 IPrintOemUI::CommonUIProp メソッドの dwMode 引数がOEMCUIP_DOCPROP場合にのみ有効です。 Unidrv または Pscript5 ドライバーによって提供されます。

pOEMDM

ユーザー インターフェイス プラグインのプライベート DEVMODEW メンバーへのポインター。 IPrintOemUI::CommonUIProp メソッドの dwMode 引数がOEMCUIP_DOCPROP場合にのみ有効です。 Unidrv または Pscript5 ドライバーによって提供されます。

dwFlags

dwMode パラメーターが OEMCUIP_DOCPROP に設定された IPrintOemUI::CommonUIProp の呼び出しの場合

プリンター ドライバーの DrvDocumentPropertySheets 関数で受信した DOCUMENTPROPERTYHEADER 構造体の fMode メンバーの内容を格納します。

dwMode パラメーターを OEMCUIP_PRNPROP に設定して IPrintOemUI::CommonUIProp を呼び出す場合

プリンター ドライバーの DrvDevicePropertySheets 関数によって受信された DEVICEPROPERTYHEADER 構造体の Flags メンバーの内容を格納します。

pDrvOptItems

プリンター ドライバーの OPTITEM 配列へのポインター。 IPrintOemUI::CommonUIProp が初めて呼び出された場合は無効です。 Unidrv または Pscript5 ドライバーによって提供されます。

cDrvOptItems

pDrvOptItems が指す配列内の OPTITEM 構造体の数。 Unidrv または Pscript5 ドライバーによって提供されます。

pOEMOptItems

OPTITEM 構造体の配列へのポインター。 IPrintOemUI::CommonUIProp 呼び出し元によって提供されます。 IPrintOemUI::CommonUIProp メソッドを 2 回目に呼び出す場合は、ユーザー インターフェイス プラグインによって定義された OPTITEM 構造体をこの配列に配置し、構造体数を cOEMOptItems に配置する必要があります。 配列に配置された OPTITEM 構造体ごとに、次の操作を行う必要があります。

  • OPTITEM 構造体の DMPubID メンバーを、定義済みの値のいずれかに設定するか、DMPUB_USERより大きい値に設定します。 定義済みの値を使用する場合は、 OPTITEM 配列全体で、それらの値が既に含まれている構造体を検索し、そのOPTIF_HIDEフラグを設定する必要があります。

  • OEMCUIPPARAM 構造体の hOEMHeap メンバーに含まれるハンドルを使用して、Windows SDK HeapAlloc 関数を呼び出して、OPTTYPES 構造体と OPTPARAMS 構造体に領域を割り当てます。 プリンター ドライバーは、不要になったときにこの領域の割り当てを解除します。

IPrintOemUI::CommonUIProp が初めて呼び出された場合は無効です。

cOEMOptItems

pOEMOptItems が指す配列に含まれる OPTITEM 構造体の数。 Unidrv または Pscript5 ドライバーによって提供されます。

IPrintOemUI::CommonUIProp メソッドを初めて呼び出す場合、cOEMOptItems の呼び出し元が指定した値は 0 です。 IPrintOemUI::CommonUIProp メソッドは、この値を変更して、メソッドが提供する OPTITEM 構造体の数を示す必要があります。 2 回目の呼び出し時に、IPrintOemUI::CommonUIProp は、pOEMOptItems が指す配列に実際に追加される OPTITEM 構造体の数を指定する必要があります。

pOEMUserData

IPrintOemUI::CommonUIProp メソッドが 2 回目に呼び出されるときに使用され、OEMCUIPCallback 関数にオプションの追加入力情報が提供されます。

OEMCUIPCallback

IPrintOemUI::CommonUIProp メソッドが 2 回目に呼び出されるときに使用され、OEMCUIPCALLBACK 型のコールバック関数のアドレスを返します。

注釈

ユーザー インターフェイス プラグインは、 IPrintOemUI::CommonUIProp メソッドとその OEMCUIPCALLBACK 型コールバック関数の両方に対する入力引数として、この構造体のアドレスを受け取ります。

この構造体と関連する関数の使用方法の詳細については、「 ユーザー インターフェイス プラグイン」を参照してください。

要件

要件 値
Header printoem.h (Printoem.h を含む)