NetDfsRemove, fonction (lmdfs.h)
Supprime un lien DFS (Distributed File System) ou une cible de lien spécifique d’un lien DFS dans un espace de noms DFS. Lors de la suppression d’une cible de lien spécifique, le lien lui-même est supprimé si la dernière cible de lien du lien est supprimée.
Syntaxe
NET_API_STATUS NET_API_FUNCTION NetDfsRemove(
[in] LPWSTR DfsEntryPath,
[in, optional] LPWSTR ServerName,
[in, optional] LPWSTR ShareName
);
Paramètres
[in] DfsEntryPath
Pointeur vers une chaîne qui spécifie le chemin d’accès UNC (Universal Naming Convention) du lien DFS.
La chaîne peut être sous l’une des deux formes suivantes. Le premier formulaire est le suivant :
\\ ShareName\DfsName\link_path
où ShareName est le nom du serveur cible racine qui héberge l’espace de noms DFS autonome ; DfsName est le nom de l’espace de noms DFS ; et link_path est un lien DFS.
Le deuxième formulaire est le suivant :
\\ Domainname\DomDfsname\link_path
où DomainName est le nom du domaine qui héberge l’espace de noms DFS basé sur le domaine ; DomDfsname est le nom de l’espace de noms DFS ; et link_path est un lien DFS.
Ce paramètre est obligatoire.
[in, optional] ServerName
Pointeur vers une chaîne qui spécifie le nom de serveur de la cible de lien. Pour plus d'informations, consultez la section Notes qui suit. Définissez ce paramètre sur NULL si le lien et toutes les cibles de lien doivent être supprimés.
[in, optional] ShareName
Pointeur vers une chaîne qui spécifie le nom de partage de la cible de lien. Définissez ce paramètre sur NULL si le lien et toutes les cibles de lien doivent être supprimés.
Valeur retournée
Si la fonction réussit, la valeur de retour est NERR_Success.
Si la fonction échoue, la valeur de retour est un code d’erreur système. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur système.
Notes
L’appelant doit disposer du privilège Administrateur sur le serveur DFS. Pour plus d’informations sur l’appel de fonctions qui nécessitent des privilèges d’administrateur, consultez Exécution avec des privilèges spéciaux.
Lorsque vous appelez NetDfsRemove pour supprimer une cible d’un lien, vous devez spécifier le même nom de serveur cible dans le paramètre ServerName que vous avez spécifié lors de la création du lien. Par exemple, si vous avez spécifié le nom DNS du serveur cible lorsque vous avez ajouté la cible au lien, vous devez spécifier le même nom DNS lorsque vous supprimez le lien. Vous ne pouvez pas spécifier le nom NetBIOS.
Exemples
L’exemple de code suivant montre comment supprimer une cible d’un lien DFS à l’aide d’un appel à la fonction 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;
}
Configuration requise
| Client minimal pris en charge | Windows Vista |
| Serveur minimal pris en charge | Windows Server 2008 |
| Plateforme cible | Windows |
| En-tête | lmdfs.h (include LmDfs.h, Lm.h) |
| Bibliothèque | Netapi32.lib |
| DLL | Netapi32.dll |