Programmer Guide/Command Reference/CHECKIT: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
|- | |- | ||
|<code>/Executable</code> | |<code>/Executable</code> | ||
|check if | |check if <var>arg</var> is executable, i.e., if it is a command, instance, macro, or class | ||
| '1' | | <code>'1'</code> if <var>arg</var> is executable | ||
| '0' | | <code>'0'</code> otherwise | ||
|- | |- | ||
|<code>/Item</code> | |<code>/Item</code> | ||
| get type of | | get type of the shell item <var>arg</var> | ||
| itemtype | | itemtype if <var>arg</var> is a shell item | ||
| '' (i.e., empty string) | | '' (i.e., empty string) otherwise | ||
|- | |- | ||
|<code>/Code</code> | |<code>/Code</code> | ||
| get type of | | get type of the source code <var>arg</var> | ||
| codetype | | codetype if <var>arg</var> is a source code | ||
| '' | | '' (i.e., empty string) otherwise | ||
|- | |- | ||
|<code>/Visible</code> | |<code>/Visible</code> | ||
| check if | | check if <var>arg</var> is a visible source code | ||
| '1' | | '1' if it is | ||
| '0' | | '0' if it is not | ||
|- | |- | ||
| <code>/File</code> | | <code>/File</code> | ||
| get full | | get full sourcefile path of source code <var>arg</var> | ||
| fullpath | | fullpath if <var>arg</var> is a source code | ||
| '' | | '' otherwise | ||
|- | |- | ||
| <code>/Style</code> | | <code>/Style</code> | ||
| get style of sourcecode | | get style of sourcecode <var>arg</var> | ||
| codestyle | | codestyle if <var>arg</var> is a source code | ||
| '' | | '' otherwise | ||
|- | |- | ||
| no option at all | | no option at all | ||
| get type of | | get type of shell item or source code <var>arg</var> | ||
| itemtype or codetype | | itemtype or codetype if <var>arg</var> is a shell item, or a source code | ||
| '' | | '' otherwise | ||
|} | |} | ||
Revision as of 19:25, 16 April 2012
var := CHECKIT arg [option]
with option being either empty, in which case the type of the shell item or of the sourcecode item arg will be returned, or one out of the following keywords:
| option | description | result on success | result on failure |
|---|---|---|---|
/Executable
|
check if arg is executable, i.e., if it is a command, instance, macro, or class | '1' if arg is executable
|
'0' otherwise
|
/Item
|
get type of the shell item arg | itemtype if arg is a shell item | (i.e., empty string) otherwise |
/Code
|
get type of the source code arg | codetype if arg is a source code | (i.e., empty string) otherwise |
/Visible
|
check if arg is a visible source code | '1' if it is | '0' if it is not |
/File
|
get full sourcefile path of source code arg | fullpath if arg is a source code | otherwise |
/Style
|
get style of sourcecode arg | codestyle if arg is a source code | otherwise |
| no option at all | get type of shell item or source code arg | itemtype or codetype if arg is a shell item, or a source code | otherwise |
//
// itemtype: a valid shellitem type (see shell items)
// codetype: 'macro', 'class' or 'spu'
// codestyle: 'local', 'main', 'shell', 'sys', 'msgHandler' or 'global'
// note: 'global' is the default codestyle if none is specified in the code header
