Função NetDfsRemove (lmdfs.h)

Artigo
08/24/2023

Remove um link do DFS (Sistema de Arquivos Distribuído) ou um destino de link específico de um link do DFS em um namespace do DFS. Ao remover um destino de link específico, o link em si será removido se o último destino de link do link for removido.

Sintaxe

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

Parâmetros

[in] DfsEntryPath

Ponteiro para uma cadeia de caracteres que especifica o caminho UNC (Convenção de Nomenclatura Universal) do link do DFS.

A cadeia de caracteres pode estar em uma das duas formas. O primeiro formulário é o seguinte:

\\ Nome_do_compartilhamento\DfsName\link_path

em que ShareName é o nome do servidor de destino raiz que hospeda o namespace dfs autônomo; DfsName é o nome do namespace do DFS; e link_path é um link do DFS.

O segundo formulário é o seguinte:

\\ Domainname\DomDfsname\link_path

em que DomainName é o nome do domínio que hospeda o namespace DFS baseado em domínio; DomDfsname é o nome do namespace do DFS; e link_path é um link do DFS.

Este parâmetro é necessário.

[in, optional] ServerName

Ponteiro para uma cadeia de caracteres que especifica o nome do servidor do destino do link. Para obter mais informações, consulte a seção Comentários a seguir. Defina esse parâmetro como NULL se o link e todos os destinos de link forem removidos.

[in, optional] ShareName

Ponteiro para uma cadeia de caracteres que especifica o nome do compartilhamento do destino do link. Defina esse parâmetro como NULL se o link e todos os destinos de link forem removidos.

Valor retornado

Se a função for bem-sucedida, o valor retornado será NERR_Success.

Se a função falhar, o valor retornado será um código de erro do sistema. Para obter uma lista de códigos de erro, consulte Códigos de erro do sistema.

Comentários

O chamador deve ter privilégio de Administrador no servidor DFS. Para obter mais informações sobre como chamar funções que exigem privilégios de administrador, consulte Executando com privilégios especiais.

Ao chamar NetDfsRemove para remover um destino de um link, você deve especificar o mesmo nome de servidor de destino no parâmetro ServerName especificado ao criar o link. Por exemplo, se você especificou o nome DNS do servidor de destino quando adicionou o destino ao link, deverá especificar o mesmo nome DNS ao remover o link. Não é possível especificar o nome NetBIOS.

Exemplos

O exemplo de código a seguir demonstra como remover um destino de um link do DFS usando uma chamada para a função 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 com suporte	Windows Vista
Servidor mínimo com suporte	Windows Server 2008
Plataforma de Destino	Windows
Cabeçalho	lmdfs.h (inclua LmDfs.h, Lm.h)
Biblioteca	Netapi32.lib
DLL	Netapi32.dll