NetWkstaTransportEnum 函数 (lmwksta.h)

项目
08/24/2023

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

指向接收数据的缓冲区的指针。此数据的格式取决于级别参数的值。此缓冲区由系统分配，必须使用 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。

如果函数失败，则返回值可能是以下错误代码之一。

返回代码	说明
ERROR_MORE_DATA	有更多条目可用。指定一个足够大的缓冲区来接收所有条目。
ERROR_INVALID_LEVEL	level 参数（指示可用的数据结构信息级别）无效。如果将级别参数指定为非零值，则返回此错误。
ERROR_INVALID_PARAMETER	一个或多个参数无效。如果 bufptr 或 entriesread 参数为 NULL 指针，则返回此错误。
ERROR_NOT_ENOUGH_MEMORY	内存不足，无法处理请求。
ERROR_NOT_SUPPORTED	不支持该请求。如果在 servername 参数中指定了远程服务器，并且远程服务器上不支持此请求，则返回此错误。
NERR_BufTooSmall	有更多条目可用。指定一个足够大的缓冲区来接收所有条目。此错误代码在 Lmerr.h 头文件中定义。

注解

成功执行 NetWkstaTransportEnum 函数不需要特殊组成员身份。

要求

要求	值
最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
目标平台	Windows
标头	lmwksta.h (包括 Lm.h)
Library	Netapi32.lib
DLL	Netapi32.dll