Return value: result of <expression>

Var ($a)

Sets ($a, 42)

$a = 42

See also "var"

Return value: result of <expression>.

VarSet ($a, 42)

Inc ($a)

Dec ($a, 2)

Represents the logical Worth true.

Return value: 1

$a = true

Represents the logical Worth wrong.

Return value: 0

$a = false

Tests whether the expression of the type Int is.

Return value: True=Wahr or False=Falsch

$result = iif (isint ($a), $a, 0)

If a character string converts in a numeric honorable value. If the character string begins with the marks " 0x ", she is considered as hexadezimal coded.

Return value: honorable variable. If the character string contains no honorable value, it is returned 0.

$a = "1"

$b = 2

$c = $a + $b * - > "12"

$d = int ($a) + $b * - > 3

Print (int (" 0xFF ")) * - > 255

Supplies the amount without forerunner from <number>.

Return value: Honorable.

Print (paragraph (42)) * - > 42

Print (paragraph (-42)) * - > 42

Supplies-1 if <number> is negative, +1 if <number> is positive and 0 if <number> 0 is.

Return value: Honorable.

Print (sgn (42)) * - > 1

Print (sgn (-42)) * - >-1

Test whether the expression of the type String is.

$result = iif (isstr ($a), $a, " 0x " +hex ($a))

If supplies ASCII-code of the first mark of a character string.

Return value: number of the ASCII-code or 0 if <string> is empty.

Print (ord ("*")) * - > 42

If the ASCII-mark supplies in the position <number> and is therefore the counterfunction from "ord".

Return value: character string with a mark.

Print (chr (42)) * - > "*"

Converts a nummerischen value to a character string. If the length <length> exists, the character string is filled up from the left beginning with the mark <leadchar> on the given length. (Standard for < leadchar > is "0").

Return value: String.

$a = 42

Print (str ($a)) * - > "42"

Print (str ($a, 5)) * - > "00042"

Print (str ($a, 5, " ")) * - > "42"

Converts a numeric value to a character string in hexadezimaler manner of writing. If the value <digits> exists, the character string with the mark "0" is filled up.

Return value: character string.

$a = 42

Print (practise witchcraft ($a, 42)) * - > " 002 A "

Print (int (" 0x " + practise witchcraft (42))) * - > 42

If supplies the length of a character string

Return value: Honorable.

Print (len ("ABC")) * - > 3

If the position of the partial character string <substr> supplies in the character string <string>. If a start position <startpos> is given(indicated), it is searched from these positions in the character string.

Return value: position or 0, if partial character string not found.

Print (pos ("b", "abcde")) * - > 2

Print (pos ("b", "abcde", 3)) * - > 0

If supplies a partial character string <string> from position <startpos> with the length <length>. If the length <length> is not given(indicated), the rest(remainder) of the character string is supplied.

Return value: character string.

Print (copy ("abcde", 3, 1)) * - > "c"

Print (copy ("abcde", 3)) * - > "cde"

Deletes in the character string <string> from position <startpos>. If the length <length> is not given(indicated), all marks are deleted up to end of the character string, apart from that soviele marks as given(indicated).

Return value:: character string.

Print (delete ("abcde", 3, 1)) * - > "abde"

Print (delete ("abcde", 3)) * - > "from"

$s = delete ($s, 1, 1) * delete 1st char of $s

Removes all leading and following marks in the character string <string>, as far as they are contained in <trimchars>. Lacks <trimchars>, all leading and following blanks are removed.

Return value:: character string.

Print (trim ("42")) * - > "42"

$WHITESPACE = " " + chr (9)

Print (trim ($line, $WHITESPACE))

If the character string <string> converts in small letter.

Return value: character string.

Print (lowercase ("AbCd")) * - > "abcd"

If the character string <string> converts in capital letter.

Return value: character string

Print (uppercase ("AbCd")) * - > "ABCD"

Addiction and replaces for the character string <find> in the character string <string> with the character string <replace>. If value is <all> True=Wahr, all found character strings are replaced, apart from that only the first occurence. If is the value <case> True=Wahr it is not considered big / kleinschreibweise.

Return value: character string

Print (replace ("abcABCabc", "b", " [X] ")) * - > " a [X] cABCabc "

Print (replace ("abcABCabc", "b", " [X] ", true)) * - > " a [X] cABCa [X] c "

Print (replace ("abcABCabc", "b", " [X] ", true, true)) * - > " a [X] approx. [X] Approx. [X] c "

Applies the content of the character string <string> as a numeric expression and supplies the result back.

Return value: Honorable

Print ("4" + "+" + "2") * - > "4+2"

Print (eval ("4" + "+" + "2")) * - > 6

If supplies TRUE if <string> fits to the regular expression (PCRE). Indication: capitalization and use of small letters is ignored normally.

Return value: TRUE (1) or FALSE (0)

$answer = "abc4efg2hij"

If (RE_Match ($answer, " 4.2"))

Print ("OK".)

Endif

Supplies the part from <string> which fits to the regular expression (PCRE-style). Indication: capitalization and use of small letters is ignored normally.

Return value: character string (is empty if nothing was found)

$answer = "abc4efg2hij"

Print (RE_Extract ($answer, " 4.2")) * - > " 4efg2 "

Print (RE_Extract ($answer, "A.*C")) * - > "ABC"

Print (RE_Extract ($answer, " (?-i) A.*C ")) * - > " "

Divides <string> in groups according to the regular expression. The groups are stored in the separate variables <varX>. Indication: capitalization and use of small letters is ignored normally.

Return value: TRUE (1): =OK, FALSE (0): = mistake

$line = " Subject: This is a test "

RE_Parse ($line, " (\S +:)\s + (. *) ", $a, $b) * - > $a = " Subject: ", $b = " This is a test "

If a character string splits in separate sections according to the regular expression on. The sections are stored in the separate variables <varX>. Indication: capitalization and use of small letters is ignored normally.

Return value: TRUE (1): = OK, FALSE (0): =Fehler

$line = " this is a test "

RE_Split ($line, "+", $a, $b) * - > $a = "This", $b = " is a test "

RE_Split ($line, "+", $a, $b, $c) * - > $a = "This", $b = "is", $c = " a test "

If the time supplies in Millisekunden since the start of Windows.

Return value: Honorable.

$start = quirks

*.

$stop = quirks

Print (" time: ", $stop - $start, "ms".)

If the current time in the Unix supplies format. (Seconds since the 01/01/1970)

Return value: Honorable

$now = times

$yesterday = $now - 2460*60

If the current GMT in the Unix supplies format. (Seconds since the 01/01/1970)

Return value: Honorable

$nowgmt = timegmt

Kovnvertiert the Unix - time format year, month, day, hour(lesson), minute, second and weekday. Variables: <yyyy> (year), <mm> (months), <dd> (day), <hh> (Grant respite), <nn> (minute), <ss> (second), <wd> (day week; 1=Sonntag..., 7=Sonnabend).

Return value: <times>

Var ($hrs, $min, $sec)

Decodetime (times, 0, 0, 0, $hrs, $min, $sec)

Print (" Current time: ", $hrs, ":", $min, ":", $sec)

If the Unix-time supplies back. Parameter: <yyyy> (year), <mm> (months), <dd> (day), <hh> (Grant respite), <nn> (minute), <ss> (second)

Return value: <times>

Encodetime (2000, 12, 31, 23, 59, 59)

With <on/off> like TRUE (< > 0) becomes the internal mistake business abgeschalte. Then the hamster does not finish the script in the mistake case. In this case measures must be met in the script to the mistake treatment to mistake treatment. Of the mistake status "ErrNum" can be questioned by the script with the function, in case of a mistake a value incomparably becomes a zero zurückgeliefert.

Return value: 0 / False: Switched off (standard; if script in the mistake case), 1 / stops True: Turned on

$OldErrCatch = ErrCatch

ErrCatch (True)

Print (42/0) * division by zero causes error

If (ErrNum < > 0)

Print (" Error: ", ErrNum, " ", ErrMsg)

Endif

ErrCatch ($OldErrCatch)

If the last mistake number supplies back.

Respect: the mistake numbers are dependent on version.

Return value: Honorable (=0:Kein mistake, < > 0: mistake)

If (ErrNum < > 0)

*.

Endif

If the last mistake message supplies back.

Return value: character string

Print (ErrMsg)

Supplies the name of the module which has caused the mistake.

Return value: character string

Print (ErrModule)

Liefer the number of the line which has caused the mistake.

Return value: Honorable

Print (ErrLineNo)

If supplies the line which has caused the mistake.

Return value: character string: String

Print (ErrLine)

Supplies the name of the script-object which has caused the mistake.

Return value: character string

Print (ErrSender)

If the program <cmdline> incl. if necessary suspended parameters starts in the working directory <workdir>. The variable <show> fixes the qualities of the program window. (0=unsichtbar, 1=normal, 2=minimiert, 3=maximiert). If the variable <wait> is like True=Wahr, the script waits for the end of the called program, otherwise the execution of the script is continued directly, while the called program works in the background. The variable <exitcode> contains the ending code of the called program.

Return value: Honorable (0=Kein mistake, < > 0=Fehler)

Execute (" notepad.exe myfile.cfg ")

Select from the .INI-file <filename> from the section <section> the value of the key <indent>. If no file name is given(indicated), the file "HScripts.ini" is applied. If no section <section> is given(indicated), the section " [all] " is applied. If the wished entry is not contained in the INI-file, becomes the value <default> zurückgeliefert.

Return value: character string

$answer = IniRead ("MyScript.ini", "answer", "last", "42")

$LastConnected = int (IniRead (" ", """, LastConnected ", 0))

Places or changes in the INI-file <filename> in the section <section> the value for <ident> on the new value <value>. If no file name is given(indicated), the file "HScripts.ini" is applied. If no section <section> is given(indicated), the section " [all] " is applied.

Return value: character string

IniWrite ("MyScript.ini", "answer", "last", $answer)

IniWrite (""" ",", LastConnected ", times)

Tests whether the file exists <filename>. The jokers "?" And "*" are admitted in the file name.

Return value: Honorable (1=existiert, 0=ist not existing(exist))

If (! Fileexists ("myfile.cfg"))

Error (" Wrong configuration! ")

Endif

If the length of the file <filename> supplies in bytes.

Return value: Honorable (-1 in the mistake case)

Print (FileSize (HamPath + "Hamster.exe"))

If the time of the last writing access to the file <filename> supplies in the Unix-format.

Return value: Honorable (-1 in the mistake case)

Print (" Your Hamster's age: ", times - file time (HamPath + "Hamster.exe") ", seconds ")

If she deletes file <filename>.

Return value: 0: OK, < > 0: mistake

FileDelete ("MyScript.tmp")

If the file <oldname> names in <newname> around.

Return value: 0: OK, < > 0: mistake

FileRename ("MyScript.dat", "MyScript.bak")

If the file <oldname> copies to <newname>.

Return value: 0: OK, < > 0: mistake

FileCopy ("MyScript.dat", "MyScript.bak")

Tests whether the catalogue <dirname> it exists. Provided that no absolute path is given(indicated), the relative information refers to the current working directory.

Return value: Honorable (1=existiert, 0=nicht existing(exist))

If (! Direxists ("mydir"))

*.

Endif

If a catalogue with the name <dirname> creates. Provided that no absolute path is given(indicated), the relative information refers to the current working directory.

Return value: 0: OK, < > 0: mistake

DirMake (HamPath + "MyScript")

If this deletes catalogue <dirname> if it is empty. Provided that no absolute path is given(indicated), the relative information refers to the current working directory.

Return value: 0: OK, < > 0: mistake

DirRemove (HamPath + "MyScript")

If the catalogue <dirname> places as a current working directory.

Indication: It is more meaningful normally to apply instead absolute catalogue information.

Return value: 0: OK, < > 0: mistake

DirChange (HamPath + "MyScript")

If the current working directory supplies back.

Return value: character string

Print (DirCurrent)

Liefer the name of the Windows-catalogue.

Return value: character string

Print (DirWindows)

Liefer the name of the Windows system-catalogue.

Return value: character string

Print (DirSystem)

See also: ListLoad, ListSave, craft files, ListDirs.

If a new list creates and supplies the associated trades back. Of this trades is expected as a parameter in all other lists-functions. Before the script end it must be released again by means of "ListFree" to avoid warehouse holes.

If the variable <sorted> is like TRUE (< > 0), the list is automatically sorted on adding new entries. If <duplicates> is like TRUE (< > 0), double entries are allowed, only once otherwise entries are taken(accepted) in the list. Indication: presupposition for the duplicate-recognition is a sorted list.

Return value:: > =0: Act for the list,-1: too many lists openly.

$list = ListAlloc

If the list deletes and gives their(her) storage space and the trades again freely. See also "ListAlloc".

Return value: 0: OK,-1: acts incorrect

Listfree ($list)

Tests whether this trades to craft <craft> is valid and - provided that given(indicated) - whether the entry No <index> exists in the list.

Return value: 1 / True: validly; 0 / False: invalid

Sub DoSomethingWithList ($list)

If (! ListExists ($list)

Error (" list lacks! ")

Endif

*.

Endsub

Deletes all entries of a list.

Return value: 0: OK;-1: acts incorrect

ListClear ($list)

If supplies the number of the lists entries.

Return value: Honorable

Print (ListCount ($list))

Supplies a lists entry to the Index <index>. The counting of the entries begins with 0 and goes to ListCount-1.

Return value: character string (empty, if entry No < index > not existed)

$i = 0

While ($i < ListCount ($list))

Print ($i, ":", ListGet ($list, $i))

Inc ($i)

Endwhile

Sets the lists entry with Index <index> on the value <value>. If the corresponding lists entry should not exist yet, he is put on what allows the use of a craft as an Array-substitute. Should be handed over nobody <value>, the entry receives a Leerstring assigned.

Return value: <value>

Craft sets ($list, 42, " The answer! ")

If the "day" supplies quality of the lists entry with No <index>. This quality exists in addition to character string content of every lists entry and contains a number. If so far not set, becomes 0 zurückgeliefert.

Return value: Honorable

$entry_itself = ListGet ($list, 42)

$tag_of_entry = ListGetTag ($list, 42)

If the "day" sets variable for the lists entry with the Index to No <index>.

Return value: <sit>

$index = ListAdd ($list, " The answer! ")

Craft set day ($list, $index, 42)

If the list contains character strings in the form of "Schlüssel=Wert", this function supplies the value to the key <key>.

Return value: character string

* Sea(lake) example under ListSetKey

If the list contains character strings in the form of "Schlüssel=Wert", this function sets the value to the key <key> on <value> or on an empty character string.

Return value: <value>

$list = ListCreate

ListSetKey ($list, "RTFM", " Read the f... Manual! ")

ListSetKey ($list, "SCNR", " Sorry, could riveted resist! ")

Print (ListGetKey ($list, "SCNR"))

Adds at the end of the list a lists entry.

Return value: Index of the new entry.

$index = ListAdd ($list, $text)

Deletes the lists entry with the Index <index>, the remaining entries walk correspondingly.

Return value: 0

$index = ListAdd ($list, $text)

Inserts a lists entry with the Index <index> of the list <craft> with the content <value>, the following entries move correspondingly.

Return value: 0

ListInsert ($list, 0, $text)

If she sorts list <craft>.

Returns: 0

Craft place ($list)

If she deletes list <craft> and adds the text <text> in lines separated by CR+LF of the list.

Return value: <text>

Craft set text ($list, $article)

Print (ListGet ($list, 0)) * - > the First line from $article

Supplies the content of the whole list as a character string, besides the separate entries (lines) of the list are separated only with CR/LF of each other.

Return value: character string

$article = ListGetText ($list)

Addiction in the list the entry <value> and supplies his(its) Index back.

Return value: > =0: Index,-1: not found

Craft set text ($list, $article)

$EndOfHdr = ListIndexOf ($list, " ")

If the list <craft> fills with the content of the text file <textfile> in lines.

Return value: 0: OK,-1: list incorrectly or file not found

ListLoad ($list, "MyScript.cfg")

If the list <craft> stores in the text file <textfile>.

Return value: 0: OK,-1: list incorrectly

ListSave ($list, "MyScript.cfg")

If the list <lists> fills with the file names from the catalogue <file-mask>.

If the variable <fullpath> is like TRUE (< > 0), the files inclusive path are specified, otherwise only the file names.

Return value: > =0: OK (number of the files), < 0: file (en) not found

Craft files ($list, HamPath + " Mails\Mail. Out\*.msg ", true)

If the list <lists> fills with the catalogue names from the catalogue <file-mask>.

If the variable <fullpath> is like TRUE (< > 0), the complete paths are specified, otherwise only the catalogue names.

Return value: > =0: OK (number of the catalogues), < 0: catalogue (e) not found

ListDirs ($list, HamPath + " Mails\*. ")

If the list fills with DFÜ-Netzwerk-Einträgen (telephone directory of the DFÜ-network).

Return value: > =0: OK (number of the entries), < 0: list incorrectly

Var ($RasConnection)

$RasConnection = SelectRasConnection

If ($RasConnection < > " ")

Print ("chooses", $RasConnection)

*.

Endif

Quit

Sub SelectRasConnection

Var ($RasList, $RasSelIndex, $RasSelName)

$RasSelName = " "

$RasList = ListAlloc

If (ListRasEntries ($RasList) > 0)

$RasSelIndex = craft box ($RasList, " select them(her): ")

If ($RasSelIndex > = 0)

$RasSelName = ListGet ($RasList, $RasSelIndex)

Endif

Endif

ListFree ($RasList)

Return ($RasSelName)

Endsub

Spends the contained text in the hamster's protocol. (Black on knows).

Return value: <text>.

Print (" And the correct answer is: ", $answer)

Causes same like 'print', however, the text is yellow lays under and looks thereby more remarkable

Return value: <text>.

Warning (" brain malfunctioning! No ideas more! Example terminiert! ")

Valid values for x:

1=Debug,

2=Detail,

3=Info,

4=System,

5=Warning,

6=Error

Return value: <text>.

Warning (" brain malfunctioning! No ideas more! Example terminiert! ")

If indicates a text box with the text <text> and the heading <caption>.

<Design> fixes the type and the switches(counter) of the text box. (Standard: "information" and "OK" switch(counter)).

Types: 0x40 (information), 0x30 (warning), 0x20 (question), 0x10 (mistake)

Switch(counter): 0x0 (OK), 0x1 (OK+Abbrechen), 0x2 (Abbrechen+Wiederholen+Ignorieren), 0x3 (Ja+Nein+Abbrechen), 0x4 (Ja+Nein), 0x5 (Wiederholen+Abbrechen)

For the preselection of the switches(counter): 0x100 for the second switch(counter) 0x200 for the third switch(counter).

Return value: 0 = (mistake), 1=OK, 2=Abbruch, 3=Abbruch, 4=Wiederholen, 5=Ignorieren, 6=Ja, 7=Nein

If (MsgBox (" What is your(their) question? ", " ", 0x20|0x4) = 6)

Error (" Unexpected answer. ")

Else

MsgBox (" Forget it... ")

Endif

Indicates in a text input box the text <text> with the heading <caption>. The input line becomes with the text <default> vorbelegt.

If the variable <code> after return is 1 (True) became the switch(counter) OK otherwise the switch(counter) "break off" operates.

Return value: character string (empty if switch(counter) "Break off" was operated.

$answer = input box (" What's the answer...? ", """, 42 ", $ok)

Indicates in a text input box the text <text> with the heading <caption>. The input line is represented with the text <default> vorbelegt, but with asterisk veiled.

If the variable <code> after return is 1 (True) became the switch(counter) OK otherwise the switch(counter) "break off" operates.

Return value: character string (empty if switch(counter) "Break off" was operated)

$answer = input box (" What's the answer...? ", """, 42 ", $ok)

If indicates a craft box with the text <text> and the heading <caption> and allows the choice from the list <craft>. The variable <default> fixes which lists entry vorausgewählt is indicated. Standard is-1, of the same meaning with " No preselection ".

If the variable <code> after return is 1 (True), the switch(counter) OK was operated, otherwise the switch(counter) "Break off".

Return value: Index of the selected entry.

Var ($list, $selindex)

$list = ListAlloc

ListAdd ($list, "41")

ListAdd ($list, "42")

ListAdd ($list, "43")

$selindex = craft box ($list, " What's the answer...? ")

Print (iif ($selindex=1, " Correct! ", " Wrong! "))

ListFree ($list)

Deletes all entries of the Schedulers.

Return value: 0

* Sea(lake) example under AtAdd

Adds to the Scheduler an entry.

The variable <subname> must contain the name auszuführenden Subroutine (see also "sub") which should be implemented to the gewüschten moment.

The variables <from> and <til> must contain the period in the "HH.MM" format in which the Subroutine should be implemented cyclic.

The variable <wdays> must contain the Wochenentage as seven marks long character string in which the Subrotiene is to be implemented. Every mark May implement the condition 1 (=Ausführen) or 0 (=nicht) accept and represents - beginning with Monday - a weekday.

The variable <rep> must contain the time interval during minutes after which the execution the Subroutine should be repeated.

The variable <immediate> decides whether the Subroutine is started immediately on adding or only at the end of the time for the first cycle. Standard is True = " immediately starting ".

Indication: a cycle always begins with the current minute

Return value: Index for the Schedulereintrag.

AtClear

AtAdd (getmails, "00:00", "06:00", "1111100", 60, true)

AtAdd (getmails, "06:00", "18:00", "1111100", 15, true)

AtAdd (getmails, "18:00", "24:00", "1111100", 60, true)

AtAdd (getmails, "12:00", " ", "0000011")

AtAdd (getnews, "03:15")

AtAdd (getnews, "18:45")

AtExecute

Quit

Sub getmails

*.

Endsub

Sub getnews

*.

Endsub

Waits, since one the Subroutinen which were added with "AtAdd" to the Scheduler, a value has incomparably run off(expired) 0 zurückliefert or to which in the variables <time-out> fixed time.

Return value:-1=timeout, > 0:Rückgabewert the Subroutine implemented finally.

* Sea(lake) example under AtAdd

Supplies denNamen of the current network-connection DFÜ back.

Return value: character string (empty if not existing(exist)).

Print (RasGetConnection)

Tests whether a network-connection DFÜ exists(consists).

Return value: 1 (True) if, 0 (False) if no.

If (! RasIsConnected)

* Dial.

Endif

Indication: this function does not become from the password - to specific functions of the hamster supports! Moreover the functions "HamRasDial" and "HamRasHangup" would have to be applied instead.

Return value: 0:Verbindung constructed; > 0: mistake-code of the DFÜ-network;-1:DFÜ network does not install

$try = 1

While (RasDial ("MyProvider", "MyUsername", "MyPassword")! = 0)

If ($try > = 3)

Error (" Dialing failed! ")

Endif

Inc ($try)

Sleep (10000)

Endwhile

Finishes network-connections DFÜ. If the variable <connid> is not given(indicated), become all DFÜ - finishes connections.

Return value: 0: OK; > 0: mistake-code;-1: DFÜ-network does not install

RasHangup

If she supplies (in most cases dynamic) IP-address which has been assigned while connecting on the DFÜ-network by the provider.

Return value: IP-address as a character string (empty if not existing(exist)).

Print (RasGetIP)

See the also function: ListRasEntries

If the result of the expression <true-result> supplies back if the condition <condition> is true, otherwise the result of the expression <false-result>.

Return value: result according to the condition <condition>.

Print (iif ($Antwort = "42", " correct! ", " wrong! "))

If the variable <value> compares to the value <compare1> and supplies - if identically - the result <result1> back. Otherwise become all combinations < compare * > / < result * >-durchgetestet. >-die character string "Else" can be used for the value < compare * as a special value. The result belonging to it becomes zurückgeliefert when no fitting value < compare * > was found for the variable <value>.

Returns: result <result> or 0 if no value < compare * > for the variable <value> was found and no Else's-twig was applied.

$word = icase ($digit, _

0, "Zero", 1, "One", 2, "Two", 3, "Three", 4, "Four", _

5, "Five", 6, "Six", 7, "Seven", 8, "Eight", 9, "Nine", _

Else, " user, we have a problem! " _

)

If the program execution branches out to the Subroutine with the label "label". The Subroutine must be finished with the order "return".

Return value: return value the Subroutine.

Print (gosub (test))

Quit

Label (test)

*.

Return (42)

If the number supplies with the script by the start handed over parameter

Supplies these, to the script by the start vomitted, parameter with the running number <index> back. Besides, the first parameter has the Index '1', with '0' becomes the script name zurückgeliefert