EnumPorts 函式
EnumPorts函式會列舉可在指定伺服器上列印的埠。
語法
BOOL EnumPorts(
_In_ LPTSTR pName,
_In_ DWORD Level,
_Out_ LPBYTE pPorts,
_In_ DWORD cbBuf,
_Out_ LPDWORD pcbNeeded,
_Out_ LPDWORD pcReturned
);
參數
-
pName [in]
-
Null 終止字串的指標，指定您要列舉其印表機埠的伺服器名稱。
如果 pName 為 Null，函式會列舉本機電腦的印表機埠。
-
層級 [in]
-
pPorts緩衝區中傳回的資訊類型。 如果 Level 為 1， pPorts 會收到 PORT_INFO_1 結構的陣列。 如果 Level 為 2， pPorts 會收到 PORT_INFO_2 結構的陣列。
-
pPorts [out]
-
接收 PORT_INFO_1 或 PORT_INFO_2 結構陣列之緩衝區的指標。 每個結構都包含描述可用印表機埠的資料。 緩衝區必須夠大，才能儲存結構成員所指向的字串。
若要判斷所需的緩衝區大小，請呼叫 enumPorts 並將 cbBuf 設定為零。 EnumPorts 失敗， GetLastError 會傳回ERROR_INSUFFICIENT_BUFFER，而 ERROR_INSUFFICIENT_BUFFER參數 會傳回保存結構和其資料陣列所需的緩衝區大小，以位元組為單位。
-
cbBuf [in]
-
pPorts所指向緩衝區的大小，以位元組為單位。
-
vmNeeded [out]
-
變數的指標，接收復制到 pPorts 緩衝區的位元組數目。 如果緩衝區太小，函式會失敗，而且變數會收到所需的位元組數目。
-
pcReturned [out]
-
接收pPorts緩衝區中傳回之PORT_INFO_1或PORT_INFO_2結構的變數指標。 這是指定伺服器上可用的印表機埠數目。
傳回值
如果函式成功，則傳回值是非零值。
如果此函式失敗，則傳回值為零。
備註
注意
這是封鎖或同步函式，可能不會立即傳回。 此函式傳回的速度取決於執行時間因素，例如網路狀態、列印伺服器設定，以及撰寫應用程式時難以預測的印表機驅動程式實作因素。 從管理與使用者介面互動的執行緒呼叫此函式，可能會使應用程式看起來沒有回應。
即使pName指定的伺服器未定義印表機，EnumPorts 函式仍可成功。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 |
Windows 2000 Professional [僅限傳統型應用程式] |
| 最低支援的伺服器 |
Windows 2000 Server [僅限桌面應用程式] |
| 標頭 |
|
| 程式庫 |
|
| DLL |
|
| Unicode 與 ANSI 名稱 |
EnumPortsW (Unicode) 和 EnumPortsA (ANSI) |