Purpose

SetPropertyValue sets the string value of the property with the supplied ID and nominated session to the supplied value.
 

Syntax

#RetVal = ObjectTagName.SetPropertyValue( ParmMap )

Operation

ObjectTagName is an object expression that evaluates to the ClientManagement control.

ParmMap is a PROIV Interface map.

hTargetSession is the session identifier.

nResourceID is the ID of a client session property.

sValue is a new string value.

Remarks

If the method succeeds, it sets the supplied string value to be the current value of the nominated property.  The client session that owns the property, receives a notification message regarding the updated property. If that session is running a screen containing a ClientManagement control, then the SessionPropertyChanged event is triggered. If the value cannot be set, it returns a non-zero result.

hTargetSession can be set to a value received by the SessionStarted event handler. In this case the property is read from the nominated client session. Alternatively the property can be read from the current session (the owner of the ClientManagement control) by setting hTargetSession to a value of 1.

If the current session was itself launched via a ClientManagement control, then setting hTargetSession to a value of 2 reads the property value from the parent session.

A resource ID in the range 1 to 9999 is interpreted as a runtime defined property and may be used as a data transfer channel from parent to child or vice-versa. Use of this transfer channel requires that the child session be running a PROIV screen function that contains an instance of the ClientManagement control. Access to resource ID values obtained via the GetNextPropertyID method do not have this constraint.

Example