NetSessionDel 函式 (lmshare.h)

發行項
03/05/2024

結束伺服器與工作站之間的網路會話。

語法

NET_API_STATUS NET_API_FUNCTION NetSessionDel(
  [in] LMSTR servername,
  [in] LMSTR UncClientName,
  [in] LMSTR username
);

參數

[in] servername

字串的指標，指定要在其中執行函式之遠端伺服器的 DNS 或 NetBIOS 名稱。如果此參數為 NULL，則會使用本機電腦。

[in] UncClientName

字串的指標，指定要中斷連線之客戶端的計算機名稱。如果 UncClientName 參數為 NULL，則使用者 名稱參數所 識別的所有會話都會在 servername 參數所指定的伺服器上刪除。如需詳細資訊，請參閱 NetSessionEnum。

[in] username

字串的指標，指定要終止其會話的用戶名稱。如果此參數為 NULL，則會終止 來自 UncClientName 參數所指定用戶端的所有用戶會話。

傳回值

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

如果函式失敗，傳回值可以是下列其中一個錯誤碼。

傳回碼	Description
ERROR_ACCESS_DENIED	用戶無法存取要求的資訊。
ERROR_INVALID_PARAMETER	指定的參數無效。
ERROR_NOT_ENOUGH_MEMORY	記憶體不足。
NERR_ClientNameNotFound	會話不存在於該計算機名稱中。

備註

只有 Administrators 或 Server Operators 本地組的成員才能成功執行 NetSessionDel 函 式。

如果您是針對 Active Directory 進行程式設計，您可以呼叫特定 Active Directory 服務介面 (ADSI) 方法來達到相同的功能，方法是呼叫網路管理會話函式。如需詳細資訊，請參閱 IADsSession 和 IADsFileServiceOperations。

範例

下列程式代碼範例示範如何使用 對 NetSessionDel 函式的呼叫，終止伺服器與工作站之間的會話。

#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 dwError = 0;
   LPTSTR pszServerName = NULL;
   LPTSTR pszClientName = NULL;
   LPTSTR pszUserName = NULL;
   NET_API_STATUS nStatus;
   //
   // Check command line arguments.
   //
   if (argc > 4)
   {
      wprintf(L"Usage: %s [\\\\ServerName] [\\\\ClientName] [UserName]\n", argv[0]);
      exit(1);
   }

   if (argc >= 2)
      pszServerName = argv[1];

   if (argc >= 3)
      pszClientName = argv[2];

   if (argc == 4)
      pszUserName = argv[3];
   //
   // Call the NetSessionDel function to delete the session.
   //
   nStatus = NetSessionDel(pszServerName,
                           pszClientName,
                           pszUserName);
   //
   // Display the result of the call.
   //
   if (nStatus == NERR_Success)
      fprintf(stderr, "The specified session(s) has been successfully deleted\n");
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);

   return 0;
}

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限桌面應用程式]
目標平台	Windows
標頭	lmshare.h (包含 Lm.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll