Click or drag to resize

AuthenticationRemoveUserFromSystem(AuthenticationUserToken, String) Method

Remove a user account from the control system list of users

Namespace: Crestron.SimplSharp.CrestronAuthentication
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public static bool RemoveUserFromSystem(
	ref AuthenticationUserToken utoken,
	string username
)

Parameters

utoken  AuthenticationUserToken
User token obtained using GetAuthentication method passed in as reference so that the access level gets updated dynamically
username  String
User name to remove from the system

Return Value

Boolean
Flag indicating whether the user was removed from the system (true=success)
Exceptions
ExceptionCondition
InvalidOperationExceptionAuthentication is not currently enabled on the controller.
AuthenticationPrivilegeExceptionHigher privileges are required to use this method.
ArgumentExceptionArguments provided to a method is not valid.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also