Platform SDK: Network Management

NetGroupSetInfo

The NetGroupSetInfo function sets the parameters of a global group in the security database.

Security Requirements

Windows NT: Only members of the Administrators or Account Operators local group can successfully execute the NetGroupSetInfo function.

Windows 2000: If you call this function on a Windows 2000 domain controller that is running Active Directory, access is allowed or denied based on the access-control list (ACL) for the securable object. The default ACL permits only Administrators and account operators to call this function. On a member server or workstation, only Administrators and account operators can call this function. For more information, see Security Requirements for the Network Management Functions.

NET_API_STATUS NetGroupSetInfo(
  LPCWSTR servername, 
  LPCWSTR groupname,  
  DWORD level,        
  LPBYTE buf,         
  LPDWORD parm_err    
);

Parameters

servername

[in] Pointer to a constant null-terminated Unicode character string specifying the name of the remote server on which the function is to execute. The string must begin with \\. If this parameter is NULL, the local computer is used.

groupname

[in] Pointer to a constant null-terminated Unicode character string specifying the name of the global group for which to set information.

level

[in] Specifies the information level of the data. This parameter can be one of the following values.

Value	Meaning
0	Specifies a global group name. The buf parameter points to a GROUP_INFO_0 structure.
1	Specifies a global group name and a comment. The buf parameter points to a GROUP_INFO_1 structure.
2	Specifies detailed information about the global group. The buf parameter points to a GROUP_INFO_2 structure.
1002	Specifies a comment only about the global group. The buf parameter points to a GROUP_INFO_1002 structure.
1005	Specifies global group attributes. The buf parameter points to a GROUP_INFO_1005 structure.

For more information, see the following Remarks section.

buf

[in] Pointer to a buffer that contains the data. The format of this data depends on the value of the level parameter.

parm_err

[out] Pointer to a DWORD value that receives the index of the first member of the group information structure in error following an ERROR_INVALID_PARAMETER error code. If this parameter is NULL, the index is not returned on error. For more information, see the following Remarks section.

Return Values

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value can be one of the following error codes.

Value	Meaning
ERROR_ACCESS_DENIED	The user does not have access to the requested information.
ERROR_INVALID_PARAMETER	One of the function parameters is invalid. For more information, see the following Remarks section.
NERR_InvalidComputer	The computer name is invalid.
NERR_NotPrimary	The operation is allowed only on the primary domain controller of the domain.
NERR_GroupNotFound	The global group name could not be found.
NERR_SpeGroupOp	The operation is not allowed on certain special groups. These groups include user groups, admin groups, local groups, and guest groups.

Remarks

The correct way to set the new name of a global group is to call the NetGroupSetInfo function, using a GROUP_INFO_0 structure. Specify the new value in the grpi0_name member. If you use a GROUP_INFO_1 structure and specify the value in the grpi1_name member, the new name value is ignored.

If the NetGroupSetInfo function returns ERROR_INVALID_PARAMETER, you can use the parm_err parameter to indicate the first member of the group information structure that is invalid. (A group information structure begins with GROUP_INFO_ and its format is specified by the level parameter.) The following table lists the values that can be returned in the parm_err parameter and the corresponding structure member that is in error. (The prefix grpi*_ indicates that the member can begin with multiple prefixes, for example, grpi1_ or grpi2_.)

Value	Member
GROUP_NAME_PARMNUM	*grpi_name**
GROUP_COMMENT_PARMNUM	*grpi_comment**
GROUP_ATTRIBUTES_PARMNUM	*grpi_attributes**

If you are programming for Active Directory, you may be able to call certain Active Directory Service Interface (ADSI) methods to achieve the same functionality you can achieve by calling the network management group functions. For more information, see IADsGroup.

Requirements