NetLocalGroupSetInfo, fonction (lmaccess.h)

Article
02/28/2024

La fonction NetLocalGroupSetInfo modifie le nom d’un groupe local existant. La fonction associe également un commentaire à un groupe local.

Syntaxe

NET_API_STATUS NET_API_FUNCTION NetLocalGroupSetInfo(
  [in]  LPCWSTR servername,
  [in]  LPCWSTR groupname,
  [in]  DWORD   level,
  [in]  LPBYTE  buf,
  [out] LPDWORD parm_err
);

Paramètres

[in] servername

Pointeur vers une chaîne constante qui spécifie le nom DNS ou NetBIOS du serveur distant sur lequel la fonction doit s’exécuter. Si ce paramètre a la valeur NULL, l’ordinateur local est utilisé.

[in] groupname

Pointeur vers une chaîne constante qui spécifie le nom du compte de groupe local à modifier. Pour plus d'informations, consultez la section Notes qui suit.

[in] level

Spécifie le niveau d’informations des données. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
0	Spécifie le nom du groupe local. Le paramètre buf pointe vers une structure LOCALGROUP_INFO_0 . Utilisez ce niveau pour modifier le nom d’un groupe local existant.
1	Spécifie le nom du groupe local et un commentaire à associer au groupe. Le paramètre buf pointe vers une structure LOCALGROUP_INFO_1 .
1002	Spécifie un commentaire à associer au groupe local. Le paramètre buf pointe vers une structure LOCALGROUP_INFO_1002 .

[in] buf

Pointeur vers une mémoire tampon qui contient les informations de groupe local. Le format de ces données dépend de la valeur du paramètre de niveau . Pour plus d’informations, consultez Mémoires tampons de fonction de gestion réseau.

[out] parm_err

Pointeur vers une valeur qui reçoit l’index du premier membre de la structure d’informations de groupe local qui a provoqué l’erreur ERROR_INVALID_PARAMETER. Si ce paramètre a la valeur NULL, l’index n’est pas retourné en cas d’erreur. Pour plus d'informations, consultez la section Notes qui suit.

Valeur retournée

Si la fonction réussit, la valeur de retour est NERR_Success.

Si la fonction échoue, la valeur de retour peut être l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_ACCESS_DENIED	L’utilisateur n’a pas accès aux informations demandées.
ERROR_INVALID_PARAMETER	L’un des paramètres de fonction n’est pas valide. Pour plus d'informations, consultez la section Notes qui suit.
ERROR_NO_SUCH_ALIAS	Le groupe local spécifié n’existe pas.
NERR_NotPrimary	L’opération est autorisée uniquement sur le contrôleur de domaine principal du domaine.
NERR_InvalidComputer	Le nom d'ordinateur est non valide.

Remarques

Si vous appelez cette fonction sur un contrôleur de domaine qui exécute Active Directory, l’accès est autorisé ou refusé en fonction de la liste de contrôle d’accès (ACL) de l’objet sécurisable. La liste de contrôle d’accès par défaut autorise uniquement les administrateurs de domaine et les opérateurs de compte à appeler cette fonction. Sur un serveur membre ou une station de travail, seuls les administrateurs et les utilisateurs avec pouvoir peuvent appeler cette fonction. Pour plus d’informations, consultez Exigences de sécurité pour les fonctions de gestion réseau. Pour plus d’informations sur les listes de contrôle d’accès, les ACL et les jetons d’accès, consultez Access Control Modèle.

Le descripteur de sécurité de l’objet LocalGroup est utilisé pour effectuer l’case activée d’accès pour cette fonction. En règle générale, les appelants doivent disposer d’un accès en écriture à l’objet entier pour que les appels à cette fonction réussissent.

Pour spécifier le nouveau nom d’un groupe local existant, appelez NetLocalGroupSetInfo avec LOCALGROUP_INFO_0 et spécifiez une valeur à l’aide du membre lgrpi0_name . Si vous appelez la fonction NetLocalGroupSetInfo avec LOCALGROUP_INFO_1 et que vous spécifiez une nouvelle valeur à l’aide du membre lgrpi1_name , cette valeur est ignorée.

Si la fonction NetLocalGroupSetInfo retourne ERROR_INVALID_PARAMETER, vous pouvez utiliser le paramètre parm_err pour indiquer le premier membre de la structure d’informations de groupe local qui n’est pas valide. (Une structure d’informations de groupe local commence par LOCALGROUP_INFO_ et son format est spécifié par le paramètre level .) Le tableau suivant répertorie les valeurs qui peuvent être retournées dans le paramètre parm_err et le membre de structure correspondant qui est en erreur. (Le préfixe lgrpi*_ indique que le membre peut commencer par plusieurs préfixes, par exemple, lgrpi0_ ou lgrpi1_.)

Valeur	Membre
LOCALGROUP_NAME_PARMNUM	lgrpi*_name
LOCALGROUP_COMMENT_PARMNUM	lgrpi*_comment

Les noms de compte d’utilisateur sont limités à 20 caractères et les noms de groupes sont limités à 256 caractères. En outre, les noms de compte ne peuvent pas être terminés par un point et ils ne peuvent pas inclure de virgules ou d’aucun des caractères imprimables suivants : « , /, , , [, ], :, |, <, , >+, =, ;, ?, *. Les noms ne peuvent pas non plus inclure des caractères de la plage 1 à 31, qui ne sont pas imprimables.

Si vous programmez pour Active Directory, vous pourrez peut-être appeler certaines méthodes ADSI (Active Directory Service Interface) pour obtenir les mêmes fonctionnalités que celles que vous pouvez obtenir en appelant les fonctions de groupe local de gestion réseau. Pour plus d’informations, consultez IADsGroup.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	lmaccess.h (include Lm.h)
Bibliothèque	Netapi32.lib
DLL	Netapi32.dll