EBSILON®Professional Online Documentation
EbsScript / EbsScript Functions / Using System Functions
In This Topic
    Using System Functions
    In This Topic

    System Functions



    External System


    These functions are used for a simple data exchange with the running EbsScript: Writing information in the EbsScript Output window and reading the inputs from a simple input window. Note that the output can also be written in a file, if a path is specified for an EbsScript output file in the general settings in the tab "Path".

    Name

    Purpose

    Arguments

    Return value

    Example

    checkFlag

    Check whether a certain license flag is set.

    This function is mainly used internally to link the execution of certain EbsScripts to the activation of licenses.

    (former flag numbering)

    1: INTEGER:
    ID of the flag to be queried

    BOOLEAN:

    true, if the corresponding flag is set in the license used

    false otherwise

    bOk:=checkFlag (12);

    checkFlagNew

    Checking whether a specific license flag is set in the license used                     

     1: INTEGER:
    ID of the flag to be queried

    INTEGER:

    Value of the flag according to the license used  

     iFlag:=checkFlag (1);

    convertTime

    Conversion of a time format in clear text in the internal representation (Days since 1.1.1900)

    1:STRING: Time format

    2: STRING (opt.):
    Format (see Chapter on Time formats)

    3: STRING (opt.):
    Regional and Language Option
    (see Chapter on Time formats

    REAL: Time in internal display

    convertTime ("25.08.2003 08:00");

    convertUTCTime

    Conversion of a time format between UTC-time, COleDateTime and clear text. One of the three time formats must be specified. (depending upon the flag conversion type), the remaining are determined

    1: INTEGER:  Conversion type
      1: from UTC,
      2: from COleDateTime,
      3: from clear text)

    2: INTEGER: UTC time

    3: REAL: COleDateTime-time

    4: STRING: time as clear text

    5: STRING: Format (see Chapter on Time formats)

    BOOLEAN:

    true: Conversion could be done

    false: Error in conversion

    strTime:="28.09.2005 10:00";

    bOk:=convertUTCTime( 3, iTime, rTime, strTime, strFormat );

    copyFile

    Copies a file

    1: STRING: source file

    2: STRING: target file

    3: BOOLEAN:
    true: no overwriting of existing file

    false: existing files may be overwritten

    BOOLEAN:

    true: file was copied

    false: file was not copied

    bOk:=copyFile ("C:\\Temp\\Test.txt", "C:\\Temp\\Test2.txt", false);

    deleteEnvironmentVariable

    deletes an environment variable

    1: STRING name of environment variable

    BOOLEAN:
    true: ok
    false: variable was not deleted

     

    deleteFile

    Deletes a file

    1: STRING: path of the file to be deleted

    BOOLEAN:
    true: file was deleted

    false: file was not deleted

    bOk:=deleteFile ("C:\\Temp\\Test2.txt" );

    getAvailableLanguages

    returns the languages available as an array of strings None ARRAY OF STRING: array containing the descriptions of the languages available

    var as:array of string;
    begin
     as:=getAvailableLanguages;
     for i:=0 to length(as)-1 do begin
      print(as[i],"\n");
     end;
    end;

    getEnvironmentVariable

    returns the value on an environment variable

    1: STRING Name of the environment variable

    2: STRING: returned value of the environment variable

    BOOLEAN:
    true: ok
    false: error during reading

     

    getEnvironmentVariables

    returns a list of names of all environment variables
     

    1: array of strings:

    BOOLEAN:
    true: ok
    false: error during reading

     

    getLanguage

    returns the language currently set in GUI None STRING: language name str:=getLanguage;

    getTickCount

    getUTCTime

    Returns the actual computer time as UTC time (seconds since 1.1.1970)

    -

    INTEGER: UTC time

     

    reConvertTime

    Conversion of a time format in internal display (days since 1.1.1900) in clear text with the specified format.

    1:REAL: Time in internal display

    2:STRING: Format (see Chapter on Time formats)

    3: STRING (opt.):
    Regional and Language Option
    (see Chapter on Time formats

    STRING: Time in clear text

    strTime:= reConvertTime (rTime, "%d.%m. %H:%M:%S");

    reConvertTimeSpan

    Conversion of a time span in internal display (days) in clear text with the specified format

    1:REAL: Time span in internal display

    2:STRING: Format (see Chapter on Time formats)

    3: STRING (opt.):
    Regional and Language Option
    (see Chapter on Time formats

    STRING: Time span in clear text

    strTime:= reConvertTimeSpan (rTime, "%H:%M:%S");

    setEnvironmentVariable

    Stores the value of an environment variable

    1: STRING Name of the environment variable

    2: STRING: value to store

    BOOLEAN:
    true: ok
    false: error during writing

     

    setLanguage

    Sets the language of the user interface 1: STRING Name of the language to be set BOOLEAN:
     true: OK
     false: could not be set
     setLanguage("English");
     setLanguage("Chinese (Simplified)");
     setLanguage("German");
     setLanguage("Turkish");
     setLanguage("Russian");

    sleep

    Stops the execution of the EbsScript for a certain time (in milliseconds).

    1: INTEGER: Waiting time in milliseconds

    -