GetJobAttributesEx 関数 (winsplp.h)

[アーティクル]
02/27/2024

警告

Windows 10以降、サードパーティの印刷プロバイダーをサポートする API は非推奨となりました。 Microsoft では、サードパーティの印刷プロバイダーへの投資はお勧めしません。さらに、v4 印刷ドライバーモデルを使用できるWindows 8以降の製品では、サードパーティの印刷プロバイダーが v4 印刷ドライバーを使用するキューを作成または管理できない場合があります。

印刷プロバイダーの GetJobAttributesEx 関数は、印刷ジョブに関する情報 (N アップ印刷オプションやリバース印刷オプションなど) を取得します。

構文

BOOL GetJobAttributesEx(
  [in]  LPWSTR     pPrinterName,
  [in]  LPDEVMODEW pDevmode,
  [in]  DWORD      dwLevel,
  [out] LPBYTE     pAttributeInfo,
  [in]  DWORD      nSize,
  [in]  DWORD      dwFlags
);

パラメーター

[in] pPrinterName

プリンター名を含む NULL で終わる Unicode 文字列への呼び出し元指定のポインター。

[in] pDevmode

印刷プロセッサまたはプリンタードライバーに渡される DEVMODEW 構造体への呼び出し元指定のポインター。

[in] dwLevel

次の表に示すように、 pAttributeInfo によって指される構造体の種類を示す呼び出し元から指定された値。詳細については、以下の 「解説 」セクションを参照してください。

dwLevel 値	pAttributeInfo によって指される構造体
1	ATTRIBUTE_INFO_1
2	ATTRIBUTE_INFO_2
3	ATTRIBUTE_INFO_3
4	ATTRIBUTE_INFO_4

[out] pAttributeInfo

印刷ジョブに関する情報を受け取る属性情報構造体 (ATTRIBUTE_INFO_1、 ATTRIBUTE_INFO_2、 ATTRIBUTE_INFO_3、または ATTRIBUTE_INFO_4) への呼び出し元指定のポインター。

[in] nSize

pAttributeInfo が指すバッファーのサイズ (バイト単位)。

[in] dwFlags

呼び出し元によって FILL_WITH_DEFAULTS に設定されている場合、スプーラーは pAttributeInfo にレベル 1 から dwLevel で指定されたレベルまでの既定値を入力します。

たとえば、 dwLevel が 4 で、FILL_WITH_DEFAULTSが指定されている場合、 pAttributeInfo には次の既定のメンバー値がATTRIBUTE_INFO_4入力されます。

dwJobNumberOfPagesPerSide = 1

dwDrvNumberOfPagesPerSide = 1

dwNupBorderFlags = 0

dwJobPageOrderFlags = 0

dwDrvPageOrderFlags = 0

dwJobNumberOfCopies = DEVMODEW の dmCopies メンバー

dwDrvNumberOfCopies = DEVMODEW の dmCopies メンバー

dwColorOptimization = 0

dmPrintQuality = DEVMODEW の dmPrintQuality メンバー

dmYResolution = DEVMODEW の dmYResolution メンバー

dwNupDirection = RIGHT_THEN_DOWN

dwBookletFlags = BOOKLET_EDGE_LEFT

dwDuplexFlags = 0

dwScalingPercentX = 100

dwScalingPercentY = 100

dwJobHandlingFlags = 0

戻り値

GetJobAttributesEx は、印刷ジョブ属性の取得に成功した場合に TRUE を 返します。それ以外の場合は、 FALSE を返します。

注釈

この関数は、まず、ドライバーが dwLevel で示される属性レベルをサポートしているかどうかを確認します。ドライバーがその属性レベルをサポートしていない場合、関数は次の下位レベル (dwLevel - 1) のサポートをドライバーに照会し、ドライバーによって提供されるサポートレベルを取得するまで、徐々に低いレベルのサポートを照会し続けます。 dwFlags が FILL_WITH_DEFAULTS に設定されている場合、関数はサポートされていないレベルの既定値を入力します。