Engine Help: S
Filtered overview of the Engine Help documentation.
@Sleep
Pauses execution of the current script for FN COUNT1 tenths of a second. Since this uses an idle wait that does not occupy the processor, this function is always preferable to an empty counting loop.
@SleepMS
Pauses execution of the current script for FN COUNT1 milliseconds. Since this uses an idle wait that does not occupy the processor, this function is always preferable to an empty counting loop.
@SortList
Sorts the TEXT/TEXTLIST TEXT1/TEXTLIST1 and returns this sorted list. Optionally, a reorganization list NUMBERLIST SEQUENCE1 can be returned. It can be used with @ReorgList to put other lists into the same order into whi …
@Soundex
Returns a numeric code for TEXT/TEXTLIST TEXT1/TEXTLIST1 that enables a homophonic (similar-sounding) comparison. It is mainly used in the address book.
@Sqrt
Calculates the square root of FN/FNLIST FN1/FNLIST1.
@StartOSComPortTransmit
Starts buffering and transmission (with handshake, etc.) for the COM port identified by OSCOMHANDLE OSCOMHANDLE1.
@StopOSComPortTransmit
Stops buffering and transmission (with handshake, etc.) for the COM port identified by OSCOMHANDLE OSCOMHANDLE1.
@StringExceptions
The string exceptions (see the StringExceptions texts) that the compiler applies to static texts are also applied by @StringExceptions to the passed TEXT TEXT1. Example @StringExceptions(TEXT1): Text:=@StringExceptions(" …
@Subset
Returns a sublist of FN/TEXT/TD/FNLIST/TEXTLIST/TDLIST/IDLIST FN1/TEXT1/TD1/FNLIST1/TEXTLIST1/TDLIST1/IDLIST1. If FN COUNT2 is positive, the first COUNT2 elements are returned; if COUNT2 is negative, the last COUNT2 elem …
@SumOfList
Returns the sum of FN/FNLIST FNLIST1/FN2. FN FROM2 and FN TO3 can be used to specify a range for the summation; the values from element FROM2 through element TO3 are then summed.
@SwitchLogDoc
After this @Function has been called, the log is continued in a new subsequent APILOG document. Example @SwitchLogDoc: @LogReport("document 1"); @SwitchLogDoc; @LogReport("document 2"); The line "document 1" is output in …
SECTION END
Last statement in an IDF document. Syntax: SECTION END;
SECTION EOF
Statement that starts the processing program in an IDF document that is to be executed after the import. All @Functions can be used. Note : This text was machine-translated and may contain inaccuracies.
SECTION IMPORT
The record to be imported is defined here. No @Functions can be used. Tabs and comments must not be used!!! Syntax: Simple field: DataType,Length,Delimiter,FieldName; List field: DataType,TotalLength,TotalDelimiter,Eleme …
SECTION INIT
A statement which starts the Processing Program, which should be run before the import process, in an IDF document. All @Functions can be used.
SECTION PROCESSING
A statement which starts the processing program, which is supposed to be run in every sentence during importation, in the IDF document
SECTION REFERENCE
In the SECTION REFERENCE fixed mappings from specific imported field values to other field values are defined. Tabs and comments must not be used!!! Syntax for a reference list: TargetDataType,ReferenceName { ImportStrin …
SECTION SYSTEM
General import parameters are defined here: Tabs and comments must not be used!!! SET SepModus: SET SepModus := @Length; The record is defined by a specific length. SET SepModus := @String; The record is defined by one o …
SET CRYPT DATATYP
Determines the data type for the encrypted API Engine fields. Text is the default. All fields, saved and encrypted after this command, are saved with this data type. DataTypText: "RT" "TEXT" Example1: SET CRYPT DATATYP:" …
SET CRYPT SUMMARY
Determines whether or not the SUMMARY flag is to be set for API engine encryted fields. The default setting is 1. All fields which are encrypted and saved using this command are saved with a SUMMARY flag depanding on the …
SET DocMultiplyer
SET DocMultiplyer: (Default value 1) Specifies how many times the document should be written.
SET MaxRecords
SET MaxRecords: Defines the maximum number of records to import. (Default value 0. This means no maximum number of records.)
SET RecordCount
SET statement in the SECTION SYSTEM in the IDF document. SET RecordCount: Number of characters to import per record.
SET RecordRepeat
SET RecordRepeat: (Default value 1) Specifies how often the delimiter string (or one of the delimiter strings) must occur before a record is actually finished.
SET SaveMain
SET SaveMain: (Default value 1) 0=Main document is not saved. 1=Main document is saved. @SaveMain in processing causes the setting to be reversed once for this main document. (If saving is generally disabled -> save. If …
SET SepModus
SET statement in the SECTION SYSTEM in the IDF document. SET SepModus: Examples: SET SepModus := @Length; The record is defined by a specific length. (see SET RecordCount.) SET SepModus := @String; The record is defined …
SET SepString
SET statement in the SECTION SYSTEM in the IDF document. SET SepString: Sets the separator string that terminates a record. The separator string (which can be built using @Char and +) can also be a list of separator stri …
SET VAR
Attaches a global variable to the processing (analog) (VariableName[GLOBAL]:=Item;). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the separating symbol for a list. Possi …
SET VAR ENV
Attaches a global variable to the processing (analog) (VariableName[GLOBAL]:=@Environment(EnvironmentVariableName);). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the se …
SET VAR SHARED
Attaches a global variable to the processing (analog) (VariableName[SHARED]:=Item;). DataTyp returns the DatenTyp of the variable and a ListSeperator (always one line only) returns the separating symbol for a list. Possi …
SHARED
SHARED is a special variable group, which is not deleted after processing/import has ended and remains in memory even after the BATCH (AEF) has ended. This means that a variable assigned to the SHARED variable group rema …
String Exceptions (Escape Sequences)
In a string in an Engine script an escape sequence can be specified. The escape sequence is introduced by a backslash (\). This is followed by an identifier that specifies the escape sequence to be performed: Identifier …
STRUCTURAL KEYWORDS
IF: Structurally branches to a block of statements if the BOOL condition is met. (In the version with ELSE, execution branches to the ELSE block if the BOOL condition is not met.) Syntax: IF(BOOL) { } ELSE { } or IF(BOOL …
SWITCH LOGDOC
After the execution of SWITCH LOGDOC, the logging will be continued in a follwing APILOG-document.
SWITCH/CASE/DEFAULT
Syntax: SWITCH(Test) { CASE("A") { } CASE("BB") { } } or SWITCH(Test) { CASE("A") { } CASE("BB") { } DEFAULT { } } The result of the SWITCH expression is compared with the res …