Release 10.1A: OpenEdge Development:
Progress 4GL Reference

> ## SET-PROPERTY( ) method

> Sets the value of the specified application-defined property associated with an unsealed Client-principal object.

> Return type: LOGICAL

> Applies to: Client-principal object handle

> Syntax
>     SET-PROPERTY( property-name, property-value )

> ``property-name``

> A character string that specifies the name of an application-defined property associated with the Client-principal object. You must enclose this character string in quotes. If you specify the Unknown value (`?`) or the empty string (""), Progress generates a run-time error.

> ``property-value``

> A character expression that contains the value for the specified property. You must enclose this character expression in quotes. If you specify the Unknown value (`?`) or the empty string (""), Progress sets the property to that value (and you cannot change it).

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

> If you call this method more than once per property, Progress generates a run-time error.

> Once all property values are set for the Client-principal object, you must seal the object using the SEAL( ) method. Once sealed, you cannot set any new or existing properties for the object. If you call this method for a sealed Client-principal object, Progress generates a run-time error.

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

> You can use the GET-PROPERTY( ) method to get the value of a single property associated with a Client-principal object, or use the LIST-PROPERTY-NAMES( ) method to retrieve a list of all properties associated with the Client-principal object.

> Example

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

>     DEF VAR hCP as HANDLE.
>     DEF VAR val-ok as LOGICAL.
>     .
>     .
>     .
>     CREATE CLIENT-PRINCIPAL hCP.
>     hCP:SET-PROPERTY(“eye-color”, “Blue”).
>     .
>     .
>     .
>     val-ok = hCP:VALIDATE-SEAL(key).

> #### See also

> GET-PROPERTY( ) method, LIST-PROPERTY-NAMES( ) method

Copyright © 2005 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095