NetMessageNameEnum 函数 (lmmsg.h)

项目
08/24/2023

[自 Windows Vista 起不支持此函数，因为信使服务不受支持。]

NetMessageNameEnum 函数列出在指定计算机上接收消息的消息别名。函数要求启动信使服务。

语法

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

parameters

[in] servername

指向常量字符串的指针，该字符串指定要对其执行函数的远程服务器的 DNS 或 NetBIOS 名称。如果此参数为 NULL，则使用本地计算机。

[in] level

指定数据的信息级别。此参数的取值可为下列值之一：

值	含义
0	返回消息别名。 bufptr 参数指向MSG_INFO_0结构的数组。
1	返回消息别名。 bufptr 参数指向MSG_INFO_1结构的数组。此级别仅出于兼容性而存在。不支持消息转发。

[out] bufptr

指向接收数据的缓冲区的指针。此数据的格式取决于级别参数的值。此缓冲区由系统分配，必须使用 NetApiBufferFree 函数释放。请注意，即使函数因ERROR_MORE_DATA而失败，也必须释放缓冲区。

[in] prefmaxlen

指定返回数据的首选最大长度（以字节为单位）。如果指定MAX_PREFERRED_LENGTH，函数将分配数据所需的内存量。如果在此参数中指定另一个值，它可以限制函数返回的字节数。如果缓冲区大小不足以容纳所有条目，则函数将返回ERROR_MORE_DATA。有关详细信息，请参阅网络管理功能缓冲区和网络管理功能缓冲区长度。

[out] entriesread

指向一个值的指针，该值接收实际枚举的元素计数。

[out] totalentries

指向一个值的指针，该值接收可能从当前恢复位置枚举的条目总数。请注意，应用程序应仅将此值视为提示。

[in, out] resume_handle

指向一个值的指针，该值包含用于继续现有邮件别名搜索的恢复句柄。第一次调用时，句柄应为零，后续调用应保持不变。如果 resume_handle 为 NULL，则不存储任何恢复句柄。

返回值

如果函数成功，则返回值NERR_Success。

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

返回代码	说明
ERROR_ACCESS_DENIED	调用方没有适当的访问权限来完成操作。
ERROR_INVALID_LEVEL	为级别参数指定的值无效。
ERROR_INVALID_PARAMETER	参数不正确。
ERROR_MORE_DATA	有更多条目可用。指定一个足够大的缓冲区来接收所有条目。
ERROR_NOT_ENOUGH_MEMORY	可用内存不足。
ERROR_NOT_SUPPORTED	不支持此请求。此错误在 Windows Vista 及更高版本上返回。
NERR_BufTooSmall	提供的缓冲区太小。

注解

只有管理员本地组的成员才能在远程服务器上成功执行 NetMessageNameEnum 函数。

若要检索有关消息名称表中特定消息别名的信息，可以调用 NetMessageNameGetInfo 函数。

要求


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