GET-PROPERTY( ) method

Gets the value of the specified application-defined property stored in the client-principal object. The client-principal object may be sealed or unsealed. If the specified property is not stored in the object, or the property does not have a value, this method returns the Unknown value (?).

Return type: CHARACTER

Applies to: Client-principal object handle

Syntax

GET-PROPERTY ( property-name )

property-name

A case-sensitive character string that specifies the name of an application-defined property stored in the client-principal object. You must enclose this character string in quotes.

You can also use the LIST-PROPERTY-NAMES( ) method to retrieve a list of all application-defined properties stored in the client-principal.

The following code fragment illustrates how to use the GET-PROPERTY( ) method:

DEFINE VARIABLE hCP  AS HANDLE    NO-UNDO.
DEFINE VARIABLE vVal AS CHARACTER NO-UNDO.
. . .
CREATE CLIENT-PRINCIPAL hCp.
. . .
vVal = hCP:GET-PROPERTY("eye-color").
DISPLAY "Eye color: " vVal.

See also

LIST-PROPERTY-NAMES( ) method, SET-PROPERTY( ) method