UserSuspend()

Suspend a User.

Public Function UserSuspend(ByVal SessionID As String, _
                            ByVal UserID As Integer) _
                            As Boolean

Parameters

SessionID
String - GUID
The current session's GUID in string format. This is a 32-character hexidecimal string in the format:
00000000-0000-0000-0000-000000000000. This is the value returned by the Login() function.
UserID
Integer
A numeric value used to represent a specific user on the system.

Returns

Boolean 
True if successful, false on failure.

Remarks

An Active User may be temporarily Suspended. When Suspended, the User cannot log into the system until Activated; however, if the UserID is used for notices, it will continue to receive notices.

To permanently remove a User from the system, use UserTerminate().

Example

Visual Basic
[insert code sample]

EventID: 1010

See Also

UserActivate()
UserTerminate()

© 2008-2011, Loren Data Corp.
All rights reserved.		 ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.