CREATE CLIENT-PRINCIPAL statement

Creates an instance of a Client-principal object dynamically at run time. Each Client-principal object instance contains information specific to one user login session. This login session may be used as an application or database user identity from an authentication domain registered in the application’s trusted authentication domain registry.

Note: You use a Client-principal object with the SET-CLIENT( ) method or SET-DB-CLIENT function to set the user identity for an ABL session or OpenEdge database. You can have only one active Client-principal object set as the current user at any one point in time for a session or database connection.

Syntax

CREATE CLIENT-PRINCIPAL client-principal-handle

client-principal-handle

A variable of type HANDLE that represents the handle of the Client-principal object.

Note

To use the Client-principal object, you must first register the authentication domain that created the object in the application’s trusted authentication domain registry for the session or database connection. To register an authentication domain, you can do either of the following:

Use the REGISTER-DOMAIN( ) and LOCK-REGISTRATION( ) methods, which register an authentication domain and then restrict the registration of additional authentication domains, respectively.
Use the LOAD-DOMAINS( ) method, which loads registered authentication domains from an OpenEdge database and then automatically restricts the registration of additional authentication domains.

See also

Client-principal object handle, LOAD-DOMAINS( ) method, LOCK-REGISTRATION( ) method, REGISTER-DOMAIN( ) method, SET-CLIENT( ) method, SET-DB-CLIENT function

OpenEdge Release 10.2B

Copyright © 2009 Progress Software Corporation