GetPrintProcessorCapabilities 関数 (winsplp.h)

印刷プロセッサの GetPrintProcessorCapabilities 関数は、指定された入力データ型に関連付けられている機能を返します。

構文

DWORD GetPrintProcessorCapabilities(
  [in]  LPTSTR  pValueName,
  [in]  DWORD   dwAttributes,
  [out] LPBYTE  pData,
  [in]  DWORD   nSize,
  [out] LPDWORD pcbNeeded
);

パラメーター

[in] pValueName

印刷プロセッサでサポートされているデータ型を表す文字列への呼び出し元指定のポインター。 文字列ポインターは LPWSTR 型である必要があります。

[in] dwAttributes

呼び出し元が指定した属性フラグ。 PRINTER_INFO_x 構造体の Attributes メンバーを参照してください。

[out] pData

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

[in] nSize

pData によって指されるバッファーのサイズを表す呼び出し元から指定された値。

値が sizeof(PRINTPROCESSOR_CAPS_1) より小さい場合、この関数は、印刷プロセッサでサポートされている構造に応じて、sizeof(PRINTPROCESSOR_CAPS_1) または sizeof(PRINTPROCESSOR_CAPS_2) と等しい値を指定する必要があります。

値が sizeof(PRINTPROCESSOR_CAPS_1) より小さい場合、winprint 印刷プロセッサは sizeof(PRINTPROCESSOR_CAPS_2) の値を指定します。

[out] pcbNeeded

pData が指すバッファーに必要な最小サイズを受け取る場所への呼び出し元指定のポインター。

戻り値

操作が成功した場合、関数は ERROR_SUCCESSを返す必要があります。 それ以外の場合は、Win32 エラー コードが返されます。

注釈

印刷プロセッサは、必要に応じて GetPrintProcessorCapabilities 関数をエクスポートできます。 この関数の目的は、印刷プロセッサがサポートするすべての入力データ型に対して、入力PRINTPROCESSOR_CAPS_1またはPRINTPROCESSOR_CAPS_2構造体を返します。

スプーラーは、アプリケーションが GetPrinterData を呼び出すときに印刷プロセッサの GetPrintProcessorCapabilities 関数を呼び出し、PrintProcCaps_datatype の形式で値名を指定します。ここで、datatype は入力データ型の名前です。 GetPrintProcessorCapabilities を呼び出す前に、スプーラーは値名文字列からPrintProcCaps_プレフィックスを削除します。

関数は、受信したバッファーが十分な大きさであるかどうかを判断し、存在する場合は、 PRINTPROCESSOR_CAPS_1 または PRINTPROCESSOR_CAPS_2 構造体を埋め、返す必要があります。 nSize の値は、PRINTPROCESSOR_CAPS_1とPRINTPROCESSOR_CAPS_2のどちらを使用するかを決定します。

関数は、実際のバッファーが十分に大きいかどうかに関係なく、必要なバッファー サイズを返すために 、常に pcbNeeded が指す場所を使用する必要があります。

指定した戻り値は、スプーラーが GetPrinterData に提供する戻り値になります。

要件

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