NetWkstaTransportEnum 函式 (lmwksta.h)

發行項
03/05/2024

NetWkstaTransportEnum 函式提供由重新導向器管理之傳輸通訊協定的相關信息，這是用戶端電腦上產生檔要求給伺服器計算機的軟體。

語法

NET_API_STATUS NET_API_FUNCTION NetWkstaTransportEnum(
  [in]      LPTSTR  servername,
  [in]      DWORD   level,
  [out]     LPBYTE  *bufptr,
  [in]      DWORD   prefmaxlen,
  [out]     LPDWORD entriesread,
  [out]     LPDWORD totalentries,
  [in, out] LPDWORD resume_handle
);

參數

[in] servername

字串的指標，指定要在其中執行函式之遠端伺服器的 DNS 或 NetBIOS 名稱。如果此參數為 NULL，則會使用本機電腦。

[in] level

要求數據的資訊層級。此參數可以是下列值。

值	意義
0	傳回工作站傳輸通訊協議資訊。 bufptr 參數指向WKSTA_TRANSPORT_INFO_0結構的陣列。

[out] bufptr

接收數據的緩衝區指標。此數據的格式取決於 level 參數的值。此緩衝區是由系統所配置，而且必須使用 NetApiBufferFree 函式釋放。請注意，即使函式因 ERROR_MORE_DATA 或 NERR_BufTooSmall而失敗，您也必須釋放緩衝區。

[in] prefmaxlen

所傳回數據的慣用長度上限，以位元組為單位。如果您指定 MAX_PREFERRED_LENGTH，函式會配置數據所需的記憶體數量。如果您在此參數中指定另一個值，它可以限制函式傳回的位元組數目。如果緩衝區大小不足以保存所有專案，則函式會傳回 ERROR_MORE_DATA 或 NERR_BufTooSmall。如需詳細資訊，請參閱網路管理功能緩衝區和網路管理功能緩衝區長度。

[out] entriesread

值指標，可接收實際列舉的項目計數。

[out] totalentries

值的指標，這個值會接收可能已從目前繼續位置列舉的項目總數。請注意，應用程式應該只將此值視為提示。

[in, out] resume_handle

值的指標，其中包含用來繼續現有工作站傳輸搜尋的繼續句柄。第一次呼叫時，句柄應該是零，後續呼叫則保持不變。如果 resumehandle 參數是 NULL 指標，則不會儲存任何繼續句柄。

傳回值

如果函式成功，傳回值會NERR_Success。

如果函式失敗，傳回值可以是下列其中一個錯誤碼。

傳回碼	Description
ERROR_MORE_DATA	有更多專案可供使用。指定足夠的緩衝區來接收所有專案。
ERROR_INVALID_LEVEL	level 參數，指出可用的數據結構資訊層級無效。如果 level 參數指定為零以外的值，就會傳回此錯誤。
ERROR_INVALID_PARAMETER	一或多個參數無效。如果 bufptr 或 entriesread 參數為 NULL 指標，就會傳回此錯誤。
ERROR_NOT_ENOUGH_MEMORY	記憶體不足，無法處理要求。
ERROR_NOT_SUPPORTED	不支援此要求。如果在 servername 參數中指定遠端伺服器，而且遠端伺服器上不支援此要求，就會傳回此錯誤。
NERR_BufTooSmall	有更多專案可供使用。指定足夠的緩衝區來接收所有專案。此錯誤碼定義於 Lmerr.h 頭檔中。

備註

成功執行 NetWkstaTransportEnum 函式不需要特殊群組成員資格。

規格需求

需求	值
最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	lmwksta.h (include Lm.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll