SNAX/HLS Application Programming Manual

Data Structures
Customization
7–10 104707 Tandem Computers Incorporated
The SNAXHLS^USEREXIT^OUT^BLOCK Structure
SNAXHLS^USEREXIT^OUT^BLOCK is used by your enabling routine to return
operating parameters to SNAX/HLS. The block contains the information defined
below. Further information might eventually be added to the end of the block by the
developer (thus preserving compatibility). Your customization enabling routine
indicates in the first word the number of bytes it is setting. The most convenient way
is to store this value in the first word:
$LEN(SnaxHLS^UserExit^OUT^Block)
The diagram depicts the structure of the block.
STRUCT SnaxHLS^UserExit^OUT^Block;
BEGIN
INT ByteSize;
INT EnableMask;
END;
ByteSize
specifies how many bytes of the ensuing structure are relevant. It specifies which
version of the data structure was used when compiling your program. The
suggested value is the length of the data structure:
$LEN( SnaxHLS^UserExit^OUT^Block )
In this way, SNAX/HLS ignores any information beyond those entries that were
known when your program was compiled. When the enabling routine is called
(described below), the parameter block is preset to values suitable for a passive
routine.
EnableMask
is a return value you return that indicates which USER EXIT routine is called by
SNAX/HLS. The possible values are as follows (bit 0 is the sign bit):
0 SNAXHLS^USEREXIT^VERB^IN is called.
1 SNAXHLS^USEREXIT^VERB^OUT is called.
2 SNAXHLS^USEREXIT^SNAX^IN is called.
3 SNAXHLS^USEREXIT^SNAX^OUT is called.
4 SNAX/HLS^USEREXIT^VRFY^BIND^RSP is called.
7 SNAX/HLS^USEREXIT^VRFY^STSN^RSP is called.
6:15 These bits are reserved and must be 0.
If none of the bits is set, SNAX/HLS assumes that no user-exit routines are being
called and ignores any further parameters.