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，則會列舉本機監視器。

層級 [in]

pMonitors所指向的結構版本。

此值可以是 1 或 2。

pMonitors [out]

接收結構陣列之緩衝區的指標。 緩衝區必須夠大，才能儲存結構成員所參考的字串。

若要判斷所需的緩衝區大小，請呼叫將 cbBuf設為零的EnumMonitors。 EnumMonitors 失敗， GetLastError 會傳回ERROR_INSUFFICIENT_BUFFER，而 ERROR_INSUFFICIENT_BUFFER參數 會傳回保留結構和其資料陣列所需的緩衝區大小，以位元組為單位。

如果Level為 1，則緩衝區會接收MONITOR_INFO_1結構的陣列，如果Level為 2，則MONITOR_INFO_2結構。

cbBuf [in]

pMonitors所指向之緩衝區的大小，以位元組為單位。

azureNeeded [out]

如果函式成功，或 cbBuf 太小，則為接收所複製位元組數目的變數指標。

pcReturned [out]

變數的指標，接收 pMonitors所指向之緩衝區中傳回的結構數目。

傳回值

如果函式成功，則傳回值是非零值。

如果此函式失敗，則傳回值為零。

備註

注意

這是封鎖或同步函式，可能不會立即傳回。 此函式傳回的速度取決於執行時間因素，例如網路狀態、列印伺服器組態，以及難以在撰寫應用程式時預測的印表機驅動程式實作因素。 從管理與使用者介面互動的執行緒呼叫此函式，可能會讓應用程式看起來沒有回應。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	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