Return Codes

SMARTMon-UX has standardized return codes (Windows users may know them better as error levels) that are returned to a calling program as the program exits. The codes are as follows:

Number	Name	Description
0	NORMAL_RETURN	Normal return code if no problems found with command.
1	FATAL_EXIT	Generic exit code indicating command syntax error.
2	INVALID_PARAM	Syntax error, but denotes invalid parameter for a command.
3	UNSUPPORTED	Command unsupported for the selected device.
4	INSUFFICIENT	Insufficient O/S resources to perform desired action.
5	TEST_MESSAGE	Test error message generated.
6	EMAIL_UNCONF	Email attempted, but settings not configured properly.
10	SCRUB_C_ERROR	Scrub-family test completed, but with errors.
11	SCRUB_T_ERR	Scrub-family test terminated early due to error(s).
12	SCRUB_T_NOTUNIQ	Scrub-family test terminated, pattern on disk is not random, disk has not been erased
13	WS_TERMINATED_ERR	Write same command terminated with errors
15	TERMINATED	Similar to INVALID_PARAM, but parameters were determined to be invalid at runtime
20	SERVICE_ERR	Windows-specific service routine general error.
21	TERMINATED_UNSAN	Terminated, command not supported on a SANtool device
22	ABORTEDBYUSER	Action terminated by user (CTRL-C or killed, or quit)
33	TERMINATED_SAN	Terminated, program unsupported on this hardware
254	SANTOOLS_CODE_1	Indicates programmer error. This is an error you should never get, but if you do, please forward it to us immediately.
255	SANTOOLS_CODE_2	Indicates programmer error. This is an error you should never get, but if you do, please forward it to us immediately.

These return codes are of value if you script SMARTMon-UX and wish to implement conditional logic based on their values. See the documentation on the -scrub family of commands to see the return codes that are passed back to the calling program in response to the command-line options sent to the peripheral(s).

Page url: http://www.santools.com/santool/index.html?return_codes.htm