PreviousNextIndex

LOGOUT( ) method

Indicates that the user represented by the sealed Client-principal object has logged out of the 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 ID using either the 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


OpenEdge Release 10.2B
Copyright © 2009 Progress Software Corporation
PreviousNextIndex