NetDfsRemove-Funktion (lmdfs.h)

Artikel
08/24/2023

Entfernt einen DFS-Link (Distributed File System) oder ein bestimmtes Linkziel eines DFS-Links in einem DFS-Namespace. Beim Entfernen eines bestimmten Linkziels wird der Link selbst entfernt, wenn das letzte Linkziel des Links entfernt wird.

Syntax

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

Parameter

[in] DfsEntryPath

Zeiger auf eine Zeichenfolge, die den UNC-Pfad (Universal Naming Convention) des DFS-Links angibt.

Die Zeichenfolge kann in einer von zwei Formen vorhanden sein. Das erste Formular ist wie folgt:

\\ShareName\DfsName\link_path

Wobei ShareName der Name des Stammzielservers ist, der den eigenständigen DFS-Namespace hostet; DfsName ist der Name des DFS-Namespace. und link_path ist ein DFS-Link.

Das zweite Formular lautet wie folgt:

\\Domänenname\DomDfsname\link_path

Dabei ist DomainName der Name der Domäne, die den domänenbasierten DFS-Namespace hostet; DomDfsname ist der Name des DFS-Namespace. und link_path ist ein DFS-Link.

Dieser Parameter ist erforderlich.

[in, optional] ServerName

Zeiger auf eine Zeichenfolge, die den Servernamen des Linkziels angibt. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise". Legen Sie diesen Parameter auf NULL fest, wenn der Link und alle Linkziele entfernt werden sollen.

[in, optional] ShareName

Zeiger auf eine Zeichenfolge, die den Freigabenamen des Linkziels angibt. Legen Sie diesen Parameter auf NULL fest, wenn der Link und alle Linkziele entfernt werden sollen.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NERR_Success.

Wenn die Funktion fehlschlägt, ist der Rückgabewert ein Systemfehlercode. Eine Liste der Fehlercodes finden Sie unter Systemfehlercodes.

Hinweise

Der Aufrufer muss über Administratorrechte auf dem DFS-Server verfügen. Weitere Informationen zum Aufrufen von Funktionen, die Administratorrechte erfordern, finden Sie unter Ausführen mit speziellen Berechtigungen.

Wenn Sie NetDfsRemove aufrufen, um ein Ziel aus einem Link zu entfernen, müssen Sie denselben Zielservernamen im ServerName-Parameter angeben, den Sie beim Erstellen des Links angegeben haben. Wenn Sie beispielsweise den DNS-Namen des Zielservers beim Hinzufügen des Ziels zum Link angegeben haben, müssen Sie denselben DNS-Namen angeben, wenn Sie den Link entfernen. Sie können den NetBIOS-Namen nicht angeben.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe eines Aufrufs der NetDfsRemove-Funktion ein Ziel aus einem DFS-Link entfernen.

#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;
}

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista
Unterstützte Mindestversion (Server)	Windows Server 2008
Zielplattform	Windows
Kopfzeile	lmdfs.h (include LmDfs.h, Lm.h)
Bibliothek	Netapi32.lib
DLL	Netapi32.dll