Programmer Guide/Command Reference/EMSG: Difference between revisions

From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import)
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==EMSG==
#emsg := EMSG <var>errorCode</var>
or
EMSG <var>tableItem</var>


<code>#emsg := EMSG <var>errorCode</var>|<var>table</var></code>
The <code>EMSG</code> command will return a string describing the meaning of the numerical error code <var>errorCode</var> returned by an S_TOOLS-STx command. If a table item (<var>tableItem</var>) is passed instead of an error code, all error descriptions are stored in the table (deleting the previous contents).


The <code>EMSG</code> command will return a string describing the meaning of a numerical error (<var>errorCode</var>) returned by an S_TOOLS-STx command. If a table item (<var>table</var>) is passed instead of an error code, all error descriptions are stored in the table (deleting the previous contents).
// store all error messages in a simple table
 
#tab := new table *
<pre>
EMSG $#tab
// store all error messages in a simple table
#tab := new table *
EMSG $#tab
</pre>
or
or
 
// check if command fails and display error message on error
<pre>
#spu := new spu * testspu pa pb pc
// check if command fails and display error message on error
if '$rc' > 0 em $rc ; SPU creation failed: $(emsg $rc)
#spu := new spu * testspu pa pb pc
if '$rc' > 0 em $rc ; SPU creation failed: $(emsg $rc)
</pre>

Revision as of 19:09, 23 March 2011

#emsg := EMSG errorCode

or

EMSG tableItem

The EMSG command will return a string describing the meaning of the numerical error code errorCode returned by an S_TOOLS-STx command. If a table item (tableItem) is passed instead of an error code, all error descriptions are stored in the table (deleting the previous contents).

// store all error messages in a simple table
#tab := new table *
EMSG $#tab

or

// check if command fails and display error message on error
#spu := new spu * testspu pa pb pc
if '$rc' > 0 em $rc ; SPU creation failed: $(emsg $rc)

Navigation menu

Personal tools