Programmer Guide/Command Reference/CHECKIT: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
var := CHECKIT arg [option] | |||
with <code>option</code> being either empty, in which case the type of the shell item or of the sourcecode item <var>arg</var> will be returned, or one out of the following keywords: | |||
{|class="einrahmen" | |||
!option!!description!!result on success!!result on failure | |||
|- | |||
|/Executable | |||
|check if 'arg' is a command, instance, macro or class | |||
| '1' | |||
| '0' | |||
|- | |||
|/Item | |||
| get type of shellitem 'arg' | |||
| itemtype | |||
| '' (i.e., empty string) | |||
|- | |||
| /Code | |||
| get type of sourcecode 'arg' | |||
| codetype | |||
| '' | |||
|- | |||
| /Visible | |||
| check if 'arg' is a visible sourcecode | |||
| '1' | |||
| '0' | |||
|- | |||
| /File | |||
| get full sourcefilepath of sourcecode 'arg' | |||
| fullpath | |||
| '' | |||
|- | |||
| /Style | |||
| get style of sourcecode 'arg' | |||
| codestyle | |||
| '' | |||
|- | |||
| no option at all | |||
| get type of shellitem or sourcecode 'arg' | |||
| itemtype or codetype | |||
| '' | |||
|} | |||
// | |||
// 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 | |||
Revision as of 18:14, 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 a command, instance, macro or class | '1' | '0' |
| /Item | get type of shellitem 'arg' | itemtype | (i.e., empty string) |
| /Code | get type of sourcecode 'arg' | codetype | |
| /Visible | check if 'arg' is a visible sourcecode | '1' | '0' |
| /File | get full sourcefilepath of sourcecode 'arg' | fullpath | |
| /Style | get style of sourcecode 'arg' | codestyle | |
| no option at all | get type of shellitem or sourcecode 'arg' | itemtype or codetype |
//
// 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
