EnumPrinterDrivers 関数

[アーティクル]
06/12/2023

EnumPrinterDrivers 関数は、指定したプリンターサーバーにインストールされているプリンタードライバーを列挙します。

構文

BOOL EnumPrinterDrivers(
  _In_  LPTSTR  pName,
  _In_  LPTSTR  pEnvironment,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pDriverInfo,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

パラメーター

pName [in]

プリンタードライバーを列挙するサーバーの名前を指定する null で終わる文字列へのポインター。

pName が NULL の場合、関数はローカルプリンタードライバーを列挙します。

pEnvironment [in]

環境を指定する null で終わる文字列へのポインター (たとえば、Windows x86、Windows IA64、Windows x64、Windows NT R4000)。このパラメーターが NULL の場合、関数は呼び出し元/クライアントの現在の環境 (移行先/サーバーではなく) を使用します。

pEnvironment 文字列に "all" が指定されている場合、EnumPrinterDrivers は、指定されたサーバーにインストールされているすべてのプラットフォームのプリンタードライバーを列挙します。

レベル [入力]

pDriverInfo バッファーで返される情報構造体の型。次のいずれかになります。

値	説明
1	DRIVER_INFO_1
2	DRIVER_INFO_2
3	DRIVER_INFO_3
4	DRIVER_INFO_4
5	DRIVER_INFO_5
6	DRIVER_INFO_6
8	DRIVER_INFO_8

pDriverInfo [out]

Level で指定されたDRIVER_INFO_* 構造体の配列を受け取るバッファーへのポインター。各構造体には、使用可能なプリンタードライバーを記述するデータが含まれています。バッファーは、構造体の配列と、構造体メンバーが指す文字列またはその他のデータを受け取るのに十分な大きさである必要があります。

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

cbBuf [in]

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

pcbNeeded [out]

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

pcReturned [out]

pDriverInfo バッファーで返される構造体の数を受け取る変数へのポインター。これは、指定されたプリントサーバーにインストールされているプリンタードライバーの数です。

戻り値

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

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

注釈

注意

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

要件

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

EnumPrinterDrivers 関数

構文

パラメーター

戻り値

注釈

要件

関連項目

フィードバック

フィードバック

その他のリソース