GDSX Manual

User Exit Descriptions
Extended General Device Support (GDSX) Manual–134303
9-12
USER^COMMANDS
is the returned value. The value of status is generated by a TAL RETURN
statement in the user code and can be one of the following:
iocb input
INT .EXT:ref
is a pointer to the IOCB containing information about the incoming SPI request,
including iocb.bufaddr[x], the address of the token buffer.
file-error output
INT:ref
is the returned file-system error code related to this request.
spi-code output
INT:ref
is the returned SPI error code for this SPI request. Supplying this value is necessary
if you want TSCODE to format the response. A value of -1 means that this
command is invalid.
Considerations
•
The TSCODE-supported FAULT procedure should only be called from the
USER^COMMANDS exit with its noretn parameter equal to 0. See the
description of the FAULT procedure in Section 8.
•
USER^COMMANDS is an integer function called only by TSCODE, never by
USCODE. USCODE returns function values to TSCODE with the TAL RETURN
statement. The permissible returned function values are described under the status
variable above.
•
Pseudo procedures may be called from this procedure.
•
You should modify the I/O buffer pointed to by iocb.bufaddr[x] only with DSM
procedures (SSPUT, SSGET, and so on). See the SPI Programming Manual. Other
references that may be helpful are:
°
GDS Management Programming Manual
°
TACL Reference Manual
°
Event Management Service (EMS) Manual
•
If you prepare a response to the SPI command, the address of the response buffer
must be in iocb.bufaddr[x] on return from this procedure.
0 The standard response is all right (that is, the user code does not have any
extra information to return in a response buffer).
1 The user exit formatted the response buffer and there is no need for TSCODE
to supply any response.