EnumMonitors 関数

EnumMonitors 関数は、指定したサーバーにインストールされているポート モニターに関する情報を取得します。

構文

BOOL EnumMonitors(
  _In_  LPTSTR  pName,
  _In_  DWORD   Level,
  _Out_ LPBYTE  pMonitors,
  _In_  DWORD   cbBuf,
  _Out_ LPDWORD pcbNeeded,
  _Out_ LPDWORD pcReturned
);

パラメーター

pName [in]

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

レベル [入力]

pMonitors が指す構造体のバージョン。

この値には、1 または 2 を指定できます。

pMonitors [out]

構造体の配列を受け取るバッファーへのポインター。 バッファーは、構造体メンバーによって参照される文字列を格納するのに十分な大きさである必要があります。

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

バッファーは、Level が 1 の場合はMONITOR_INFO_1構造体の配列を受け取り、Level が 2 の場合は構造体MONITOR_INFO_2します。

cbBuf [in]

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

pcbNeeded [out]

関数が成功した場合にコピーされたバイト数を受け取る変数へのポインター。 cbBuf が小さすぎる場合は必要なバイト数。

pcReturned [out]

pMonitors が指すバッファーで返された構造体の数を受け取る変数へのポインター。

戻り値

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

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

注釈

注意

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

要件

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

関連項目

印刷

印刷スプーラー API 関数

MONITOR_INFO_1

MONITOR_INFO_2