A-Shell Reference

As of July 2024 and A-Shell 7.0.1761, AMOS has been renamed to ASHELL, which see for details. To maintain backward compatibility, AMOS is now an alias for ASHELL.

Deprecated.

xcall MIAMEX, MX_XCBDATAX, xcbadr, opcode, parmno, var

MX_XCBDATAX (MIAMEX 81) This function provides a means for an SBX to retrieve parameters passed to it from the calling program, and to pass parameters back. It remains supported but has been deprecated since A-Shell version 6.0, having been superseded by the family of X-ARGs which offer several advantages, including working with Functions and Procedures as well as SBXs. See MX_XCBDATAX for details on migration to the newer statements.

Parameters

xcbadr  (Num)

must be set to the address of the parameter structure. This value is passed on the command line to the SBX routine.

opcode  (Num)

0 (mxop_get) to retrieve a parameter or 1 (mxop_Set) to pass it back. For convenience, these values are mapped in the xcall.bsi file as xcbget and xcbput, respectively.

parmno  (Num)

is the number of the parameter to receive or send, starting from 1.

var

is the actual variable to receive or send. It should be mapped in a way that is "reasonably compatible" with the actual type and size passed to the subroutine, although conversions and truncations will be applied automatically if necessary.

See Also

Modified July 2017

Deprecated. See Comments below.

xcall MIAMEX, MX_XCBINFOX, xcbadr, xcbcnt, xcbstructx

coMX_XCBINFO (MIAMEX 80) is needed at the start of an SBX subroutine to retrieve information about the parameters which were passed to the subroutine. Because every subroutine needs this information, the xcall.bsi file which is included by every subroutine includes a call to this function.

Parameters

xcbadr (Num)

must be set to the address of the parameter structure. This value is passed on the command line to the SBX routine.

xcbcnt  (Num)

returns the number of parameters passed.

xcbstructx

is a structure containing information about the parameters, mapped as follows:

MAP1 XCBSTRUCTX

MAP2 XCBSTRUCT(20)         ! up to 20 parameters

  MAP3 XCB'PTYPE,b,2      ! 0=X, 2=S, 4=F, 6=B, +8=I, +16=array

  MAP3 XCB'PSIZE,b,2      ! size of parameter

Comments

This function is still supported but has been deprecated since the introduction of the .ARGCNT dot variables and the .ARGTYP and .ARGSIZ dot functions which are more elegant and preferred. See History.

Refer to Writing SBX Subroutines for more information on this and related MIAMEX functions.

History

2017 July, A-Shell 6.4.1553:  XCB'PTYPE() is now stripped to just the low 5 bits (4 bit type code and 1 bit array flag) to avoid confusion with values that were not defined when this function was implemented. See .ARGTYP and .ARGSIZ for the latest complete set of argument type flags.

2014 January, A-Shell 6.1.1373.0: .ARGTYP and .ARGSIZ dot functions; MX_XCBINFO now deprecated.