NetSessionGetInfo 函数 (lmshare.h)

项目
08/24/2023

检索有关在特定服务器和工作站之间建立的会话的信息。

语法

NET_API_STATUS NET_API_FUNCTION NetSessionGetInfo(
  [in]  LMSTR  servername,
  [in]  LMSTR  UncClientName,
  [in]  LMSTR  username,
  [in]  DWORD  level,
  [out] LPBYTE *bufptr
);

parameters

[in] servername

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

[in] UncClientName

指向字符串的指针，该字符串指定要为其返回信息的计算机会话的名称。此参数是必需的，不能为 NULL。有关详细信息，请参阅 NetSessionEnum。

[in] username

指向一个字符串的指针，该字符串指定要返回其会话信息的用户的名称。此参数是必需的，不能为 NULL。

[in] level

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

值	含义
0	返回建立会话的计算机的名称。 bufptr 参数指向SESSION_INFO_0结构。
1	返回计算机的名称、用户的名称，以及在计算机上打开的文件、管道和设备。 bufptr 参数指向SESSION_INFO_1结构。
2	除了为级别 1 指示的信息外，还返回客户端的类型以及用户建立会话的方式。 bufptr 参数指向SESSION_INFO_2结构。
10	返回计算机的名称;用户名;以及会话的活动和空闲时间。 bufptr 参数指向SESSION_INFO_10结构。

[out] bufptr

指向接收数据的缓冲区的指针。此数据的格式取决于级别参数的值。有关详细信息，请参阅网络管理功能缓冲区和网络管理功能缓冲区长度。

此缓冲区由系统分配，必须使用 NetApiBufferFree 函数释放。

返回值

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

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

返回代码	说明
ERROR_ACCESS_DENIED	用户无权访问请求的信息。
ERROR_INVALID_LEVEL	为级别参数指定的值无效。
ERROR_INVALID_PARAMETER	指定的参数无效。
ERROR_NOT_ENOUGH_MEMORY	可用内存不足。
NERR_ClientNameNotFound	不存在具有计算机名称的会话。
NERR_InvalidComputer	计算机名无效。
NERR_UserNotFound	找不到用户名。

注解

只有管理员或服务器操作员本地组的成员才能在级别 1 或级别 2 成功执行 NetSessionGetInfo 函数。级别 0 或级别 10 的调用不需要特殊的组成员身份。

如果要对 Active Directory 进行编程，则可以调用某些 Active Directory 服务接口 (ADSI) 方法，以实现通过调用网络管理会话函数可以实现的相同功能。有关详细信息，请参阅 IADsSession 和 IADsFileServiceOperations。

如果在成员服务器或工作站上以信息级别 1 或 2 调用此函数，则所有经过身份验证的用户都可以查看该信息。

示例

下面的代码示例演示如何使用调用 NetSessionGetInfo 函数来检索有关会话的信息。此示例调用 NetSessionGetInfo，将信息级别指定为 10 ( SESSION_INFO_10) 。如果调用成功，代码将输出有关会话的信息。最后，该示例释放为信息缓冲区分配的内存。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "Netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 10;
   LPSESSION_INFO_10 pBuf = NULL;
   LPTSTR pszServerName = NULL;
   LPTSTR pszUNCClientName = NULL;
   LPTSTR pszUserName = NULL;
   NET_API_STATUS nStatus;
   //
   // Check command line arguments.
   //
   if (argc == 3)
   {
      pszUNCClientName = argv[1];
      pszUserName = argv[2];
   }
   else if (argc == 4)
   {
      pszServerName = argv[1];
      pszUNCClientName = argv[2];
      pszUserName = argv[3];
   }
   else
   {
      wprintf(L"Usage: %s [\\\\ServerName] \\\\ClientName UserName\n", argv[0]);
      exit(1);
   }
   //
   // Call the NetSessionGetInfo function, specifying level 10.
   //
   nStatus = NetSessionGetInfo(pszServerName,
                               pszUNCClientName,
                               pszUserName,
                               dwLevel,
                               (LPBYTE *)&pBuf);
   //
   // If the call succeeds,
   //
   if (nStatus == NERR_Success)
   {
      if (pBuf != NULL)
      {
         //
         // Print the session information. 
         //
         wprintf(L"\n\tClient: %s\n", pBuf->sesi10_cname);
         wprintf(L"\tUser:   %s\n", pBuf->sesi10_username);
         printf("\tActive: %d\n", pBuf->sesi10_time);
         printf("\tIdle:   %d\n", pBuf->sesi10_idle_time);
      }
   }
   //
   // Otherwise, indicate a system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated memory.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

   return 0;
}

要求


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