NetDfsRemove 函式 (lmdfs.h)

發行項
03/14/2023

移除分散式檔案系統 (DFS) 連結或 DFS 命名空間中 DFS 連結的特定連結目標。移除特定連結目標時，如果移除連結的最後一個連結目標，則會移除連結本身。

語法

NET_API_STATUS NET_API_FUNCTION NetDfsRemove(
  [in]           LPWSTR DfsEntryPath,
  [in, optional] LPWSTR ServerName,
  [in, optional] LPWSTR ShareName
);

參數

[in] DfsEntryPath

指定 DFS 連結之 UNC) 路徑 (通用命名慣例的字串指標。

字串可以是兩種形式之一。第一個表單如下所示：

\\ShareName\DfsName\link_path

其中 ShareName 是裝載獨立 DFS 命名空間之根目標伺服器的名稱; DfsName 是 DFS 命名空間的名稱;和 link_path 是 DFS 連結。

第二個表單如下所示：

\\DomainName\DomDfsname\link_path

其中 DomainName 是裝載網域型 DFS 命名空間的功能變數名稱; DomDfsname 是 DFS 命名空間的名稱;和 link_path 是 DFS 連結。

此為必要參數。

[in, optional] ServerName

指定連結目標伺服器名稱之字串的指標。如需詳細資訊，請參閱接下來的＜備註＞一節。如果要移除連結和所有連結目標，請將此參數設定為 Null 。

[in, optional] ShareName

指定連結目標共用名稱稱的字串指標。如果要移除連結和所有連結目標，請將此參數設定為 Null 。

傳回值

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

如果函式失敗，則傳回值是系統錯誤碼。如需錯誤碼的清單，請參閱系統錯誤碼。

備註

呼叫端必須在 DFS 伺服器上具有系統管理員許可權。如需呼叫需要系統管理員許可權之函式的詳細資訊，請參閱以特殊許可權執行。

當您呼叫 NetDfsRemove 以從連結中移除目標時，您必須在建立連結時指定的 ServerName 參數中指定相同的目標伺服器名稱。例如，如果您在將目標新增至連結時指定了目標伺服器的 DNS 名稱，則必須在移除連結時指定相同的 DNS 名稱。您無法指定 NetBIOS 名稱。

範例

下列程式碼範例示範如何使用 對 NetDfsRemove 函式的呼叫，從 DFS 連結中移除目標。

#include <windows.h>
#include <lm.h>
#include <lmdfs.h>
#include <stdio.h>
#pragma comment(lib, "Netapi32.lib")

void wmain(int argc, wchar_t *argv[])
{
   DWORD res;
   //
   // All parameters are required.
   //
   if (argc < 4)
      wprintf(L"Syntax: %s DfsEntryPath ServerName ShareName\n", argv[0]);
   else
   {
      //
      // Call the NetDfsRemove function 
      //  to remove the DFS link.
      //
      res = NetDfsRemove(argv[1], argv[2], argv[3]);
      //
      // Display the result of the call.
      //
      if(res == 0)
         printf("Removed DFS link\n");
      else
         printf("Error: %u\n", res);
   }
   return;
}

需求


最低支援的用戶端	Windows Vista
最低支援的伺服器	Windows Server 2008
目標平台	Windows
標頭	lmdfs.h (包括 LmDfs.h、Lm.h)
程式庫	Netapi32.lib
Dll	Netapi32.dll