Index | PAL Intro | Commands | Registers | Indices | Stack | Macros | Classes | Attributes | Errors


Manual Reference Pages  - obj_edit (5)

NAME

obj/edit - Edit a nexus object in an edit buffer

CONTENTS

Synopsis
Description
Error Handling
Examples
See Also
Author

SYNOPSIS

obj/edit write, ![target] <, write, ![target] ... >

DESCRIPTION

Initialises new object edit buffers (see obj_def(5)) and associates with existing nexus objects. The arguments are grouped in pairs of write and read:

write Register to store the next edit buffer in. The edit buffer will be defined by the next read argument.
![target]
  Register or index identifying the nexus object that is to be edited.

When editing a nexus object, this instruction will set-up an empty edit buffer and associate with a nexus object. This association allows the edit buffer to be committed back to the originated object without requiring a further object reference (see obj_commit(5)).

ERROR HANDLING

A runtime error is generated if an object referenced in a read argument does not exist, or is the wrong type.

EXAMPLES

The following demonstrates how to edit a nexus object. This assumes that the object NoSuchUser already exists.

.main  
% Open an edit buffer
obj/edit P0, ![NoSuchUser]

% Replace the description attr/mod P0, [description], [No such user]
% Commit back to the original location obj/commit P0

SEE ALSO

pal_commands(5), pal_registers(5), pal_indices(5), obj_def(5), obj_clone(5), obj_commit(5), obj_clear(5), class_add(5), class_del(5), attr_add(5), attr_del(5), attr_mod(5), attr_mvadd(5), attr_mvdel(5), attr_mvmod(5),
PROSE Assembly Language at prose.sourceforge.net.

AUTHOR

Copyright (c) 2002-2008 Mark R. Bannister <cambridge@users.sourceforge.net>.

This is free software and can be downloaded from prose.sourceforge.net; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


PAL 1.0 obj_edit (5) 31 August 2008
Generated by manServer 1.07 from man5/obj_edit.5 using man macros.