|
UserInfoUserIsInLocalGroup Method
|
Determines if user is in the specified local groupName.
Namespace: GSF.IdentityAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.246-beta+ff392465a0262ee2737937d4127fc3c2f08c6dcd
Syntaxpublic static bool UserIsInLocalGroup(
string groupName,
string userName
)
Public Shared Function UserIsInLocalGroup (
groupName As String,
userName As String
) As Boolean
public:
static bool UserIsInLocalGroup(
String^ groupName,
String^ userName
)
static member UserIsInLocalGroup :
groupName : string *
userName : string -> bool
GSF.Identity.UserInfo.UserIsInLocalGroup = function(groupName, userName);
View SourceParameters
- groupName String
- Group name to test.
- userName String
- User name to test.
Return Value
Booleantrue if user is in group; otherwise,
false.
ExceptionsException | Condition |
---|
ArgumentNullException | groupName or userName was null. |
ArgumentException | No groupName or userName was specified. |
InvalidOperationException | Could not determine if user was in 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 detect
Active Directory user accounts and groups that may exist in the local group when the userName
is prefixed with a domain name and a backslash "\".
See Also