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
);

parameters

[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)
Library	Netapi32.lib
DLL	Netapi32.dll