Logout

SOAP

Logout( aHandle, 

            aDeleteUserRecord, 

            &aErrorMsg );

REST

/Logout?Handle=<Value>&DeleteUserRecord=<Value> 

Returns: ErrorMsg );

Description: Logout removes the login entry and frees any resources associated with this user.

aHandle The value created in the call to Login().   It is considered undefined after a call to SOAPLogout().

aDeleteUserRecord may be set to true in order to delete the user account from the system after the logout is complete.  This parameter is ignored unless the account was created by LoginAsClone.  (As indicated by a login that starts with "_@_").

&ErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

Example: Logout( lHandle, lErrorMsg );