Función NetDfsRemove (lmdfs.h)

Artículo
08/24/2023

Quita un vínculo del sistema de archivos distribuido (DFS) o un destino de vínculo específico de un vínculo DFS en un espacio de nombres DFS. Al quitar un destino de vínculo específico, se quita el vínculo en sí si se quita el último destino del vínculo.

Sintaxis

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

Parámetros

[in] DfsEntryPath

Puntero a una cadena que especifica la ruta de acceso de convención de nomenclatura universal (UNC) del vínculo DFS.

La cadena puede estar en una de las dos formas. El primer formulario es el siguiente:

\\ShareName\DfsName\link_path

donde ShareName es el nombre del servidor de destino raíz que hospeda el espacio de nombres DFS independiente; DfsName es el nombre del espacio de nombres DFS; y link_path es un vínculo DFS.

El segundo formulario es el siguiente:

\\Nombrededominio\DomDfsname\link_path

donde DomainName es el nombre del dominio que hospeda el espacio de nombres DFS basado en dominio; DomDfsname es el nombre del espacio de nombres DFS; y link_path es un vínculo DFS.

Este parámetro es obligatorio.

[in, optional] ServerName

Puntero a una cadena que especifica el nombre del servidor del destino del vínculo. Para obtener más información, vea la sección Comentarios que se muestra más adelante. Establezca este parámetro en NULL si se van a quitar el vínculo y todos los destinos de vínculo.

[in, optional] ShareName

Puntero a una cadena que especifica el nombre del recurso compartido del destino del vínculo. Establezca este parámetro en NULL si se van a quitar el vínculo y todos los destinos de vínculo.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NERR_Success.

Si se produce un error en la función, el valor devuelto es un código de error del sistema. Para obtener una lista de códigos de error, consulte Códigos de error del sistema.

Comentarios

El autor de la llamada debe tener privilegios de administrador en el servidor DFS. Para obtener más información sobre las funciones de llamada que requieren privilegios de administrador, consulte Ejecución con privilegios especiales.

Al llamar a NetDfsRemove para quitar un destino de un vínculo, debe especificar el mismo nombre de servidor de destino en el parámetro ServerName que especificó al crear el vínculo. Por ejemplo, si especificó el nombre DNS del servidor de destino al agregar el destino al vínculo, debe especificar el mismo nombre DNS al quitar el vínculo. No se puede especificar el nombre NetBIOS.

Ejemplos

En el ejemplo de código siguiente se muestra cómo quitar un destino de un vínculo DFS mediante una llamada a la función NetDfsRemove .

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

Requisitos


Cliente mínimo compatible	Windows Vista
Servidor mínimo compatible	Windows Server 2008
Plataforma de destino	Windows
Encabezado	lmdfs.h (include LmDfs.h, Lm.h)
Library	Netapi32.lib
Archivo DLL	Netapi32.dll