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


Manual Reference Pages  - reg_xload (5)

NAME

reg/xload - Read length of text or byte strings

CONTENTS

Synopsis
Description
Error Handling
Examples
See Also
Author

SYNOPSIS

reg/xload write, ([text])

DESCRIPTION

Returns the length of the given text argument. The return value will be a psInteger type returned as a PSUNIT_TYPE_XVALUE.

The text argument can be a register of type PSUNIT_TYPE_PALTEXT or PSUNIT_TYPE_STRING.

ERROR HANDLING

A runtime error is generated if an argument provided is of the wrong type.

EXAMPLES

reg/xload P0, ([A long and winding road.])
  Returns 24 as an integer as a PSUNIT_TYPE_XVALUE in register P0.
reg/xload PUSH, (PULL)
  Pulls string from stack and pushes length of string back onto stack.

SEE ALSO

pal_commands(5), pal_registers(5), pal_indices(5), reg_load_text(5).
PROSE Assembly Language at prose.sourceforge.net.

AUTHOR

Copyright (c) 2002-2017 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 reg_xload (5) 11 September 2017
Generated by manServer 1.07 from man5/reg_xload.5 using man macros.