LOGOUT( ) method

Indicates that the user represented by the sealed client-principal object (in the LOGIN state) has logged out of their current user login session. This is a general purpose method an application can use to invalidate, or terminate access to, a sealed client-principal object. Once logged out, you can no longer use the client-principal object to set a user identity using either the SECURITY-POLICY:SET-CLIENT( ) method or SET-DB-CLIENT function.

Return type:

LOGICAL

Applies to:

Client-principal object handle

 

Syntax 

LOGOUT( )

If you call this method for an unsealed client-principal object, the AVM generates a run-time error. You can use the AUTHENTICATION-FAILED( ) method to invalidate an unsealed client-principal object.

If successful, this method returns TRUE. Otherwise, it returns FALSE. The AVM also sets the LOGIN-STATE attribute for the client-principal object to "LOGOUT".

Calling this method generates an audit event and creates an audit record for the event in all connected audit-enabled databases according to each database’s current audit policy settings.

See also:

AUTHENTICATION-FAILED( ) method, LOGIN-STATE attribute, SET-CLIENT( ) method, SET-DB-CLIENT function