gtpc2m69 | C/C++ Language Support User's Guide |
This function causes a storage dump to be issued by the system error
routine, and may optionally display a message at prime CRAS. The ECB
may be exited if desired. The serrc_op_ext function allows a
prefix character to be concatenated with the system error number; thus
you can distinguish between IBM and user calls that code the same system error
number. This function is designed to allow users who have coded the
serrc_op function with the slist parameter to define
their own prefixes with minimal change to the existing code. Other
users should code the serrc_op_ext function.
Format
#include <tpfapi.h>
void serrc_op_slt(enum t_serrc status, int number, const char *msg,
void *slist[], char prefix);
- status
- The status of the ECB following the dump. This argument must belong
to enumeration type t_serrc, which is defined in
tpfapi.h. Code the defined term SERRC_EXIT
to force the ECB to exit, SERRC_RETURN to cause a return to the
calling program, or SERRC_CATA to cause a catastrophic
error.
- number
- The identification number for the dump. This argument is an integer
and should be a unique number ranging from 1 to X'FFFFFF'.
- msg
- This argument is a pointer to type char, which is a message
text string to be displayed at the CRAS console and appended to the
dump. This string must be terminated by a \0 and must not exceed 255
characters. Strings longer than 255 characters are truncated at the
255th character. If no message is desired, code the defined term
NULL.
- slist
- This argument is a pointer to an array of pointers to type
void, indicating extra areas of storage which are to be displayed
on the dump. See TPF General Macros for a
detailed explanation of slist format and effects. If no
storage list exists, code this parameter as NULL. If no
storage list exists, code the defined term NULL.
- prefix
- This argument is an uppercase alphabetic character that is concatenated
with the system error number in the console message and in the dump.
You can use any uppercase alphabetic characters in the following ranges:
A-H and J-V. The letters I and W-Z are reserved
for IBM use. The default prefix is U.
Normal Return
Void.
Error Return
Not applicable.
Programming Considerations
None.
Examples
The following example forces a storage dump bearing ID number A012345 (A is
the prefix) to be issued. The control returns to the program following
the dump. The message, "ERROR OCCURRED", is displayed at the
prime CRAS and is appended to the dump.
#include <tpfapi.h>
·
·
·
serrc_op_slt(SERRC_RETURN,0x12345,"ERROR OCCURRED", NULL,'A');
Related Information