Click or drag to resize

UserInfoAddUserToLocalGroup Method

Adds an existing user to the specified local groupName.

Namespace: GSF.Identity
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public static bool AddUserToLocalGroup(
	string groupName,
	string userName
)
View Source

Parameters

groupName  String
Group name to add local user to.
userName  String
Existing local user name.

Return Value

Boolean
true if user was added to local group; otherwise, false meaning user was already in group.
Exceptions
ExceptionCondition
ArgumentNullExceptiongroupName or userName was null.
ArgumentExceptionNo groupName or userName was specified.
InvalidOperationExceptionCould not add user to local group.
Remarks
This function will handle Windows service virtual accounts by specifying the complete virtual account name, such as @"NT SERVICE\MyService", as the userName. This function can also add Active Directory user accounts and groups to the local group the when the userName is prefixed with a domain name and a backslash "\".
See Also