IMPORT-PRINCIPAL( ) method

IMPORT-PRINCIPAL( ) method

Imports a sealed Client-principal object, from its raw data form, and assigns it to a Client-principal object handle. The receiving Client-principal object handle assumes the property and attribute settings defined in the source object when it was exported using the EXPORT-PRINCIPAL( ) method.

Return type: LOGICAL

Applies to: Client-principal object handle
Syntax
IMPORT-PRINCIPAL( expression ) 
expression

A RAW expression containing the Client-principal object data to import. If the specified expression has the Unknown value (?), the AVM generates a run-time error.

The receiving Client-principal object must be unsealed. If not, the AVM generates a run-time error.

If you set properties on the receiving Client-principal object handle before calling this method, either by having previously imported the object or by setting them individually, the property values are lost.

If successful, this method returns TRUE. Otherwise, it returns FALSE.

You can use the imported Client-principal object to set a user ID using either the SET-CLIENT( ) method or SET-DB-CLIENT function.

Calling this method does not generate an audit event or an audit record.

The following code fragment illustrates how to use the IMPORT-PRINCIPAL( ) method:
DEFINE VARIABLE hCP    AS HANDLE NO-UNDO. 
DEFINE VARIABLE raw-cp AS RAW    NO-UNDO. 
. . . 
CREATE CLIENT-PRINCIPAL hCP. 
. . . 
hCP:IMPORT-PRINCIPAL(raw-cp). 
See also: EXPORT-PRINCIPAL( ) method, SET-CLIENT( ) method, SET-DB-CLIENT function

Syntax
IMPORT-PRINCIPAL( `expression` )

DEFINE VARIABLE hCP AS HANDLE NO-UNDO. DEFINE VARIABLE raw-cp AS RAW NO-UNDO. . . . CREATE CLIENT-PRINCIPAL hCP. . . . hCP:IMPORT-PRINCIPAL(raw-cp).

OpenEdge Release 10.2B