Home  /  Autodocs  /  rexxsyslib.library

NAME

GetRexxVarFromMsg
retrieve the value of a Rexx variable (V45)

SYNOPSIS

error = GetRexxVarFromMsg(var,msg,out)
A0 A2 A1

LONG GetRexxVarFromMsg(const UBYTE *var,const struct Message *msg,
UBYTE *buffer)

FUNCTION

Retrieves the value of an ARexx variable whose name is given as first argument, and places its length into the output buffer.

INPUTS

var
Name of the variable to be read. A stem variable is fine.

msg
Pointer to a rexx message received by this program defining the execution environment from which the variable is read.

out
buffer of 256 characters to hold the value of the variable.

RESULT

error
an error code from <rexx/errors.h> or 0 for success.

SEE ALSO

GetRexxBufferFromMsg(), SetRexxVarFromMsg(), GetRexxVar() in amiga.lib

BUGS

This function always assumes that the target buffer is at least 256 characters long. Reading longer variables will create an error. Furthermore, this function only supports NUL-terminated values (which is generally the case, though).