NetUseEnum 函式 (lmuse.h)

發行項
08/24/2023

NetUseEnum函式會列出本機電腦與遠端伺服器上資源之間的所有目前連線。

您也可以使用 WNetOpenEnum 和 WNetEnumResource 函式來列舉網路資源或連線。

語法

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

參數

[in] UncServerName

要執行此函式之電腦的 UNC 名稱。如果此參數為 Null，則會使用本機電腦。如果指定的 UncServerName 參數是遠端電腦，則遠端電腦必須使用舊版遠端存取通訊協定機制支援遠端 RPC 呼叫。

如果 已定義_WIN32_WINNT 或 FORCE_UNICODE ，則此字串為 Unicode。

[in] LevelFlags

要求之資料的資訊層級。此參數可以是下列其中一個值。

值	意義
0	指定本機裝置名稱和遠端資源的共用名稱稱。 BufPtr參數會指向USE_INFO_0結構的陣列。
1	指定本機裝置與共用資源之間的連線相關資訊，包括線上狀態和類型。 BufPtr參數會指向USE_INFO_1結構的陣列。
2	指定本機裝置與共用資源之間的連線相關資訊。資訊包括線上狀態、連線類型、使用者名稱和功能變數名稱。 BufPtr參數會指向USE_INFO_2結構的陣列。

[out] BufPtr

接收資訊結構的緩衝區指標。此資料的格式取決於 Level 參數的值。此緩衝區是由系統所配置，而且當不再需要資訊時，必須使用 NetApiBufferFree 函式釋放。請注意，即使函式因 ERROR_MORE_DATA而失敗，您仍必須釋放緩衝區。

[in] PreferedMaximumSize

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

[out] EntriesRead

值指標，可接收實際列舉的專案計數。

[out] TotalEntries

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

[in, out] ResumeHandle

值的指標，其中包含用來繼續搜尋的繼續控制碼。第一次呼叫時，控制碼應該是零，後續呼叫則保持不變。如果 ResumeHandle 為 Null，則不會儲存任何繼續控制碼。

傳回值

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

如果函式失敗，則傳回值是系統錯誤碼。如需錯誤碼的清單，請參閱系統錯誤碼。

傳回碼	描述
ERROR_INVALID_PARAMETER	不正確參數已傳遞至函式。如果在BufPtr或entriesread參數中傳遞Null指標，則會傳回此錯誤。
ERROR_MORE_DATA	還有更多要傳回的資料。如果緩衝區大小不足以保存所有專案，就會傳回此錯誤。
ERROR_NOT_SUPPORTED	不支援此要求。如果 UncServerName 參數不是 Null ，而且遠端伺服器不支援使用舊版遠端存取通訊協定機制的遠端 RPC 呼叫，就會傳回此錯誤。
其他	使用 FormatMessage 取得傳回錯誤的訊息字串。

備註

呼叫 NetUseEnum 函式不需要特殊群組成員資格。除非使用舊版遠端存取通訊協定的下層相容性，否則無法在遠端伺服器上執行此函式。

若要擷取一個網路連線的相關資訊，您可以呼叫 NetUseGetInfo 函式。

此函式僅適用于伺服器訊息區 (LAN Manager 工作站) 用戶端。 NetUseEnum函式不支援分散式檔案系統 (DFS) 共用。若要列舉使用不同網路提供者 (WebDAV 或 DFS 共用的共用，例如) ，請使用 WNetOpenEnum、 WNetEnumResource和 WNetCloseEnum 函式。

需求


最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	lmuse.h (包括 Lm.h、Lmcons.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll