Control Structures

to put contents

Supported By

Syntax

to put variableName (into|before|after) contents
   statementList
end put

Description

The to put contents handler defines the behavior of a user-defined object when its contents are modified by the put command. When a script modifies the contents of a user-defined object, the statements in the to put contents handler are executed. The value being put into, before, or after the object's contents is passed through the local variable variableName.

If no to put contents handler is defined for a user-defined object type, objects of that type cannot be modified as containers.

Notes

Unlike parameters to an on or a function handler, which are converted to strings unless declared otherwise, the parameter to a to put contents handler is kept as-is, as if declared as a variant.

This structure is only valid inside an object type structure.

Compatibility

In OpenXION 1.3 or later, due to a more correct understanding of how containers work, user-defined objects can no longer be containers, and this structure is no longer supported.

See Also

object type, put