EnumPrintProcessorDatatypes 関数

EnumPrintProcessorDatatypes 関数は、指定された印刷プロセッサでサポートされているデータ型を列挙します。

構文

BOOL EnumPrintProcessorDatatypes(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pPrintProcessorName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pDatatypes,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

パラメーター

pName [in]

印刷プロセッサが存在するサーバーの名前を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、ローカル印刷プロセッサのデータ型が列挙されます。

pPrintProcessorName [in]

データ型が列挙される印刷プロセッサの名前を指定する null で終わる文字列へのポインター。

レベル [入力]

pDatatypes バッファーで返される情報の種類。 このパラメーターは 1 である必要があります。

pDatatypes [out]

DATATYPES_INFO_1構造体の配列を受け取るバッファーへのポインター。 各構造体は、使用可能なデータ型を記述します。 バッファーは、構造体の配列と、構造体メンバーが指す文字列またはその他のデータを受け取るのに十分な大きさである必要があります。

必要なバッファー サイズを確認するには、cbBuf を 0 に設定して EnumPrintProcessorDatatypes を呼び出します。 EnumPrintProcessorDatatypes は失敗し、 GetLastError は ERROR_INSUFFICIENT_BUFFERを返し、 pcbNeeded パラメーターは構造体とそのデータの配列を保持するために必要なバッファーのサイズ (バイト単位) を返します。

cbBuf [in]

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

pcbNeeded [out]

関数が成功した場合に pDatatypes バッファーにコピーされたバイト数を受け取る変数へのポインター。 バッファーが小さすぎると、関数は失敗し、変数は必要なバイト数を受け取ります。

pcReturned [out]

pDatatypes バッファーで返される構造体の数を受け取る変数へのポインター。 これは、サポートされているデータ型の数です。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。

注釈

注意

これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

v

Windows Vista 以降では、リモート プリント サーバーからのデータ型情報がローカル キャッシュから取得されます。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー	Winspool.h (Windows.h を含む)
ライブラリ	Winspool.lib
[DLL]	Winspool.drv
Unicode 名と ANSI 名	EnumPrintProcessorDatatypesW (Unicode) と EnumPrintProcessorDatatypesA (ANSI)

関連項目

印刷

印刷スプーラー API 関数

DATATYPES_INFO_1

EnumPrintProcessors