Loading...
 

CX_SYSTEM_OBJECT

CX_SYSTEM_OBJECT

Class hierarchy
Description:

The CX_SYSTEM_OBJECT object exists only once in the system (a so-called singleton). The IV command SystemObject and GetManager(SYSTEM) return this object. It provides a number of functions that can be called with the instruction Call:
(An example is the Easter function, which calculates the date of Easter Sunday in a given year. Logically, it belongs to the CX_DATE class, but it only needs a year number for the calculation, so it does not need a CX_DATE object. )

fundamental functions that control the object behaviour

Name MA* Parameters Return value Description
CheckMask CHECK_TERM, CHECK_DOMAIN returns the currently valid mask bits
GetDateLimit CX_SPAN_DATE Possible range of a date
GetDialogTimeout
210371
CX_VALUE | ZERO Returns the currently set system-wide dialogue timeout.
GetRegisteredSecurity
225667
CX_SECURITYReturns the access rights currently active in the system
SessionDate CX_DATE get the current session date
SetCheckMask CHECK_TERM, CHECK_DOMAIN or both Control validity of objects, default is CHECK_TERM | CHECK_DOMAIN
SetDateLimit CX_SPAN_DATE Limits within which a date may move
SetDialogTimeout
210371
CX_VALUE | CX_TIME | ZERO Sets the system-wide dialogue timeout for all types of dialogues.
SetSessionDate CX_DATE Set session date, date object are generated with this date
SetTimeStamp mode (TRUE / FALSE) when changing an object, time and user are registered in the object
with mode = FALSE this is switched off - useful for administrative maintenance tasks
with mode = TRUE Return to normal behaviour
SetValidityDate CX_DATE Set validity date, controls the accessibility of validated objects
SystemDate CX_DATE get the system date
ValidityDate CX_DATE returns the current validity date

Register interrupts such as key combinations to interrupt the InstantView® program flow

Name MA* Parameters Return value Description
EnterKeyInterrupt VECTOR<INTEGER>, INTEGER, OBJECT for the key combination (1. parameter) a message (2. parameter) is registered; 3. parameter is receiver of the message or ZERO.
The specified key combination can be used to interrupt the execution of InstantView® instructions ... more information
EnterNamedInterrupt
199655
STRING, INTEGER, CXI_OBJECT registers an interrupt similar to EnterKeyInterrupt under an identifier
→ is used by MorphIT
RemoveKeyInterrupt VECTOR<INTEGER> a key combination registered with EnterKeyInterrupt is deactivated again
RemoveNamedInterrupt
199655
STRING an interrupt registered with EnterNamedInterrupt is removed

further functions for controlling InstantView

Name MA* Parameters Return value Description
EnableRemoteMessages allows to send a message (SendMsg(message, REMOTE)) to a ClassiX® application running on another host
GetLastError
190791
Reads the error memory after a CallWeak and deletes it.
GetResetModulesProtectionSet
231940
COLLECTIONReturns the set of modules protected from ResetModules and ReloadModules .
IdleFor
190834
CX_VALUE Returns the duration (in seconds) since the last InstantView processing
IdleSince
190834
CX_DATETIME Returns the time of the last InstantView processing
ProcessPendingRequests Instructs InstantView to process all open messages sent with PostMsg. This method ends when all open messages have been processed, only then is the next statement processed.
QueueIsEmpty INTEGER Truth value that indicates whether there is still an instruction in the command queue. This can be the case if there are still instructions generated by the system (e.g. Rq4Data() for the ListView widget) running in the background.
RegisterAttentionNotification INTEGER Registers an InstantView® message, which is triggered when Attention is called instead of the corresponding dialogue.
RegisterErrorNotification INTEGER Registers an InstantView® message, which is triggered when an error (exception) occurs instead of the corresponding dialogue.
ReloadModules
218091
Like ResetModules. Additionally the .ext file is reloaded.
ResetModules sets all modules to the start state (except current and GLOBAL module). All variables are set to INVALID state and all windows are closed.
RemoteClients VECTOR&lmt;STRING> Returns a list of all clients that can currently receive remote messages. A string always has the format "COMPUTERNAME (IP address) | PID | User ID | Login date | Database name(s)", for example, "HIWI (192.168.1.109) | 2164 | 0 | 2005-3-22 15:29:37 | y:\classix\projects\classix.cxd | y:\classix\projects\classix2.cxd". If the own client had previously called EnableRemoteMessages, it also appears in this list. If no client in the network can accept remote messages, the vector is empty.
RemoteServicesAvailable INTEGER Checks that all conditions are met in this machine to enable EnableRemoteMessages and other remote functions to function. While the remote functions report an error, this function returns FALSE (remote functions cannot be used at this time) or TRUE (all conditions are met).
Start STRING, VECTOR<Object> Starts a new ClassiX® process and initialises it with transferred parameters.

Locales

Name MA* Parameters Return value Description
GetAllLocales
173619
CX_MASTER_LOCALE Download all locales
CreateSublocales INTEGER, INTEGER, STRING CX_LOCALE loads a locale and all its direct and indirect subordinated locales from the locales file (CX_LOCALES_FILENAME) and returns the locale.
GetCountries COLLECTION
The locale objects for all countries are read from the database or - if not available there - from the locales file
GetCountries2 COLLECTION
The locale object for all countries is only read from the locales file (not from the database).
GetLocale CX_LOCALE returns the current locale object of the ClassiX® system (is always transient)
GetPersistentLocale CX_LOCALE A persistent copy of GetLocale, if available, otherwise the result of GetLocale
SetLocaleByName INTEGER, INTEGER, STRING Searches the CX_LOCALE object matching the parameters and registers it with the ClassiX® system as the current locale. It is first searched in the database, then in the file CX_LOCALE_FILENAME.
SetLocaleByObject CX_LOCALE registers the transferred object (CX_LOCALE or class derived from it) as current locale with the ClassiX® system.

Languages

Name MA* Parameters Return value Description
GetCurrentLanguage INTEGER
GetEnglishLanguage INTEGER
GetLanguage STRING INTEGER
GetMaxLanguages INTEGER Returns the currently set maximum possible number of languages.
SetMaxLanguages INTEGER Sets the maximum possible number of languages.
GetLanguageName INTEGER STRING Name of the language for a language index
GetLiterals VECTOR<CX_SYSTEM_TEXT_LITERAL> Vector of descriptions of text constants of the ClassiX® system
ParseAppsWhForLiterals INTEGERno return value - results:
VECTOR<CX_SYSTEM_TEXT_LITERAL>is obtained via the message (parameter).
Parse all currently declared modules for text constants.
ParseForLiterals STRING, STRING, INTEGER no return value - results:
VECTOR<CX_SYSTEM_TEXT_LITERAL>is obtained via the message (parameter 3)
Read InstantView® modules in browser mode, then fully parse and find all text constants (ML strings)
The first parameter takes one or more paths (separated by semicolons), the file mask determines which files in the paths should be processed (usually "*.mod")
StoreUsageInfo STRING VECTOR<CX_SYSTEM_TEXT_LITERAL> save current use of the text literals to a file

Generate date objects

Name MA* Parameters Return value Description
Century INTEGER CX_SPAN_DATE Date period for the specified time interval
Decade INTEGER, INTEGER CX_SPAN_DATE Date period for the specified time interval
Easter INTEGER CX_DATE Easter date in the year indicated
Millenium INTEGER CX_SPAN_DATE Date period for the specified time interval
Month INTEGER, INTEGER CX_SPAN_DATE Date period for the specified month
Quarter INTEGER, INTEGER CX_SPAN_DATE Date period for the given quarter
SummerWinterChangeDate Year CX_DATE End of summer time
SummerWinterChangeTerm Year CX_DATETIME End of summer time
SummerWinterChangeTime CX_SPAN_TIME End of summer time
Tertian INTEGER, INTEGER CX_SPAN_DATE Date period for the specified tertial
Week INTEGER, INTEGER CX_SPAN_DATE Date period for the specified week
WinterSummerChangeDate Year CX_DATE Start of summer time
WinterSummerChangeTerm Year CX_DATETIME Start of summer time
WinterSummerChangeTime CX_SPAN_TIME Start of summer time
Year INTEGER CX_SPAN_DATE Date period for the specified year

Text editing

Name MA* Parameters Return value Description
Atoi STRING INTEGER converts string to an integer value
BankClearingFormat VECTOR VECTOR Conversion of text according to Bank Clearing Standard
CalculateNameVectorDistance
231250
VECTOR&lmt;STRING>,
VECTOR&lmt;STRING>,
CX_AMOUNT,
CX_AMOUNT
CX_FLOATCalculates the normalised DL distance between two string vectors.
CommonWriting STRING STRING Conversion from text to upper/lower case
ConvertFromUTF STRING STRING Converts from UTF8 to the current code page
ExtractNumber VECTOR, INTEGER VECTOR returns a string (with length INTEGER) in which all non-number characters are replaced with 0.
FindMLStrings COLLECTION
finds all multilingual text constants in the loaded ClassiX® system.
IsAlpha STRING INTEGER returns a 1 if there is a letter in the string
ToLower STRING STRING upper case -> lower case
ToUpper STRING STRING lower case -> upper case
SetCommonWritingParams INTEGER, VECTOR Setting the parameters for converting text to upper/lower case

Transformation tablesas objects/object sets of the class CX_ENUM_TABLE

Name MA* Parameters Return value Description
CheckEnumTables COLLECTION Test for ambiguities
GetAllEnumObjects COLLECTION all text files for enumeration tables known by binding to data fields are read. Result: the enumeration tables as objects of class CX_ENUM_TABLE
GetEnumObject STRING, INTEGER CX_ENUM_TABLE returns the requested transformation table as an object of the class CX_ENUM_TABLE
GetEnumObjectsFromFile STRING COLLECTION the text file for enumeration tables is read. Result: the enumeration tables defined there as objects of class CX_ENUM_TABLE
MissingEnumTables VECTOR Test: are all enumeration tables linked to data fields also available?

Visualising system information

Name MA* Parameters Return value Description
AllClusterInfo OBJECT, STRING OBJECT Database address of the data field
ClusterInfo OBJECT, STRING VECTOR<Object> Database address of the data field
DefineMember CX_VESSEL Create a new member
DefineSlot CX_VESSEL Creating a new slot
The function searches for a free place in the dictionary of the ClassiX® system and creates an entry for a dynamic data field there. This entry is 'packed' into an object of the class CX_VESSEL so that the dictionary entry can be edited with InstantView®. DrainWindow for the created object updates not only the (transient) dictionary but also the corresponding entry in the database. Of course, the latter only applies if the meta-information from CLASSIX.INI is stored in the database.
DefineSpecifier CX_VESSEL Create a new Specified
DerivedClasses INTEGER VECTOR<CX_VESSEL> all derived classes
GetConflictingPersEntries VECTOR<cx_vessel> Examines all persistent dictionary entries for consistency
GetCopyrights STRING Copyrights of all foreign libraries used in ClassiX
GetExtDDI INTEGERVECTOR〈CX_VESSEL〉 DDI of the class classID
GetExternFileName
229890
STRINGThe name of the .ext file passed by the external parameter when the ClassiX system is started. (Or empty string)
GetExternFilePath
229890
STRINGThe full file path to the .ext file used at system startup. (Or empty string)
GetExtMDI INTEGERVECTOR〈CX_VESSEL〉 MDI of the class classID
GetEventName INTEGERSTRINGReturns the name of a message constant, or "?" if an unknown constant was passed.
GetIndexEntries VECTOR〈CX_VESSEL〉 all registered indexed slots (see Dictionary section)
GetIniFileName STRINGThe .ini file passed at the start of the ClassiX system (parameter ini_file).
GetIniFilePath
229890
STRINGThe full file path to the .ini file passed by the --ini_file parameter at system startup.
GetMemberEntries VECTOR〈CX_VESSEL〉 all registered members (see section Dictionary)
GetObjDDI OBJECT VECTOR<Object> DDI of the object
GetObjMDI OBJECT VECTOR<Object> MDI of the object
GetRetrieveEntries VECTOR<cx_vessel> all registered query functions (see Dictionary section)
GetSlotByName STRING CX_VESSEL Return of a specific slot
GetSlotEntries VECTOR<cx_vessel> all potentially possible dynamic data fields
GetSlotEntry INTEGERCX_VESSEL Return of a specific slot
GetSpecifiers VECTOR<cx_vessel> all potentially possible specifiers
GetSpecifierByName
221162
STRINGCX_VESSELReturn of a specified specifier
GetStartFileName
229890
STRINGThe startup file (.cxp) passed when ClassiX is started.
GetStartFilePath
229890
STRINGThe startup file (.cxp) passed when ClassiX is started.
If only a file name was passed at start-up, then this method returns the full file path.
GetVersion STRING Version of the DLLs
GetVersionAppsWH STRING Version of the AppsWH
ReloadSlotDefinitions Updates the existing slots by reloading the .ini
SaveDictionary STRING writes all information from section dictionary to a file

Access to InstantView® objects

Name MA* Parameters Return value Description
GetAWHDictionary CX_TRANSIENT_DICTIONARY Dictionary of modules read in browser mode (thesaurus)
GetBindMessage INTEGER returns a message bound to CX_FORMULA
GetControlWindow 188485 CX_WIDGET Returns the current control window
GetCurrentModule CX_MODULE Current module, corresponds to the command Module
GetCurrentWindow CX_WIDGET Current window
GetFocusWidget CX_WIDGET Widget that currently has the focus (i.e. responds to keyboard input)
GetGlobaleModule CX_MODULE GLOBAL module
GetModuleKeyWords VECTOR&lmt;STRING> all terms from the AWHDictionary
GetModules 0 or 1 VECTOR〈CX_MODULE〉 all modules (0 - normal, 1 - browser mode)
GetWidgetByID
230893
STRINGCX_WIDGETReturns the widget for the passed widget ID
GetWindows VECTOR〈CX_WIDGET〉 all currently visible Windows
ParseLib STRING STRING Reading InstantView® modules
ParseLib2 STRING, STRING STRING Read InstantView® modules. The first parameter determines the file mask (e.g. *.mod), the second parameter takes one or more paths (separated by semicolons)
ParseForLiterals STRING, STRING, INTEGER no return value - results:
VECTOR<CX_SYSTEM_TEXT_LITERAL>is obtained via the message (parameter 3)
Read InstantView® modules in browser mode, then fully parse and find all text constants (ML strings)
The first parameter takes one or more paths (separated by semicolons), the file mask determines which files in the paths should be processed (usually "*.mod")
RemovePrePostUpdateFunction INTEGER, STRING, STRING Cancels a PrePostUpdate function for the specified data field
RemoveSlotPrePostUpdateFunction STRING Cancels a PrePostUpdate function for the specified slot
ResetUnitNames All unit names defined by the user in the database can be changed with the ChangeUnitNames function (from CX_RATE_TABLE). This function announces the change in InstantView®.
SetBindMessage INTEGERINTEGER only for CX_FORMULA. Binds a message to CX_FORMULA objects that is sent when an error occurs in the calculation.
SetPrePostUpdateFunction INTEGER, STRING, STRING Registers a function (of a model class) for a data field of a model class. The function is called before and after the data field is changed. It is used to track complicated indexes or to log the change
SetSlotPrePostUpdateFunction STRING, STRING like SetPrePostUpdateFunction, only for slots
Unit Parameters Units flags, as INTEGER or constant VECTOR<cx_unit_parameter> returns all units with corresponding flag

Functionality of the operating system

Name MA* Parameters Return value Description
DLLOffsetsToLineNumber
Up to Dll version 222083
STRINGSTRINGConvert offsets to line numbers
CreateDirectories
222610
STRING Creates the passed directory structure
Execute STRING file, where the file is an .exe file as well as any other file, e.g. "x:\dir\abc.html" or "http://www.classix.de/". If the file is not a programme, the corresponding programme is started, in the example the default browser of the system.
Execute2 STRING, STRING, STRING, STRING, INTEGER As above, but highly controllable:
Commando:
"edit": Opens the editor for the document 'File
"explore": opens the directory 'file
"find": Starts a search starting from the start directory
"open": Opens 'file' (a document, program or directory)
"print": prints the document 'file

Flags' controls the visibility of the window with the document. Possible values are 0 to 11. 1 is used in Execute (see above).
FindFiles STRING, INTEGERVECTOR< CX_FILE_INFO> Searches all files for a specific pattern and then sorts them according to the sorting mode:
0: names (case sensitive)
1: Names (case insensitive)
2: Creation date
3: Date of last modification
4: Date of last access (not for all file systems)
FindFilesByName STRING VECTOR<string> Searches all files for a specific pattern and then sorts them by file name (case sensitive)
FindInPath
224203
STRING, STRINGSTRING | INVALIDSearches the specified directory list for a file or directory
GetComputerName STRING get the name of the computer in the Windows network
GetEnvironment STRING STRING Returns the value of an operating system variable
CanonicalizePath

199720

STRING STRING Simplifies a path that contains "..." and "...".
GetExtensionsOfOS STRING Additional information, e.g. installed service pack
GetGuiResources INTEGERINTEGER current resource consumption, for 0 - GUI resources (graphical user interface), for 1 User Resources. Only works with Windows 2000.
GetMajorVersionOfOS INTEGER Main version of the operating system
GetMinorVersionOfOS INTEGER Subversion of the operating system
GetNameOfOS STRING "Windows 95" or "Windows NT", depending on whether the Windows is an NT (NT4, 2000, XP) or 95 (95, 98, ME) version
GetOperationSystem STRING current name of the operating system
GetPID INTEGER PID (Process ID) of the running ClassiX® instance
GetShortPathname STRING STRING Returns the short form of the file name. Thus, "c:\own files" becomes "c:\own~1". The file or directory must exist! In case of an error the parameter is returned.
GetTempFileName STRING Creates a temporary file with a unique name and returns the name of the created temporary file.
IsRunningOnTerminalServer INTEGER Does ClassiX® run on a terminal server?
LoadedDLLs VECTOR<Object> Get information about loaded DLLs
SetEnvironment STRING, STRING STRING Set the value of an operating system variable or create a new one.
SubstituteEnvironmentVariables
230257
STRINGSTRINGReplaces all environment variables in the passed STRING
System STRING 234596
INTEGER
Pass command to command interpreter of the operating system
system2 STRING 234596
INTEGER
Like System, but no new window is created for the command
RunSystemShell
184204
STRING | VECTOR<STRING> STRING Same as System, except that the console output of the command is returned as the result.
Wait INTEGER Pauses the programme run for a certain time

Unit accuracy

Name MA* Parameters Return value Description
RateTablePrecision STRING, INTEGERINTEGER returns the(internationally) usual number of decimal places of a given unit
UnitPrecision STRING, INTEGERINTEGER returns the(national) usual number of decimal places of a given unit

Calculating with units

Name MA* Parameters Return value Description
AddOverwriteRate CX_RATE Logs an overwriting unit conversion table to the machine. Each call expands the list of overwriting tables. Individual tables can be deregistered with DeregisterRate, all overwriting tables with RemoveAllOverwriteRates. Further notes ...
CreateCurrencyRate STRING, OBJECT, STRING, INTEGER CX_CURRENCY_RATE Creates an object of type CX_CURRENCY_RATE. Conversions are performed with a precision of 5 digits.
Example:
"$" 1.03212 "EUR" 6 SystemObject Call(CreateCurrencyRate)
Creates a currency conversion object with the exchange rate 1.03212€/$, where you can convert from € to $ and vice versa (see conversion types). The function leaves a CX_VALUE_PER in memory, which is not released by the garbage collection => please call it only if needed and reuse once created CX_CURRENCY_RATE objects as often as possible.
This object is cleared away from the garbage collection if it is not stored in a variable. This also applies if it is logged on to the system via AddOverwriteRate, for example!
DeregisterRate CX_RATE Logs off the unit conversion table (including overwriting conversion tables and those logged on with SetRate) from the machine - further notes ...
ExportUnitDefinitions
219866
STRINGProvides a textual representation of all units currently known in the system with their definition.
GetAllRates CX_RATE_TABLE Returns all registered unit conversion tables or NULL
GetDefaultCurrency STRING Delivers the current default currency
GetDefaultUnit STRING returns the current default unit
GetDimensions VECTOR<string> currently registered unit names
GetRate CX_RATE_TABLE returns the currently logged in unit conversion table
IsRateRegistered CX_RATE INTEGER Checks whether the unit is registered with the machine
RegisterRate CX_RATE Logs the unit conversion table into the machine - further notes ...
RemoveAllOverwriteRates Logs off all overwriting unit conversion tables from the machine.
RemoveEuroRates Disable Euro conversion
SetDefaultCurrency STRING Sets the current default currency
SetDefaultUnit STRING Sets the unit with which the CX_VALUE objects are generated
SetDimensions VECTOR<string> Register units for the Dimension function
SetEuroRates Enable Euro conversion
SetRate CX_RATE_TABLE Register unit conversion table - further notes ...

Functionality of the object manager (see also GetManager(OBJECT))

Name MA* Parameters Return value Description
GetActiveClients VECTOR< CX_JSON_OBJECT> Information about the clients active on the database
GetCurrentDeadlockRetry INTEGERWithin RetryTXN , index should be used instead.
MaxDeadlockRetries INTEGERNumber of automatic retries for deadlock within RetryTXN.
MaxLayers INTEGERNumber of layers
MaxLockTimeoutRetries
224453
INTEGERNumber of automatic retries at lock timeout within RetryTXN.
SetLockTimeout INTEGER, INTEGER how long to wait for a page, intervals in ms
SetMaxDeadlockRetries INTEGER Set number of automatic retries on deadlock within RetryTXN .
SetMaxLockTimeoutRetries
224453
INTEGER Set the number of automatic retries at lock timeout within RetryTXN .

Bar code

Name MA* Parameters Return value Description
BarCode25Interleaved STRING, INTEGER STRING
CheckDigitMod10W3 STRING STRING

User Settings

The following functions are used to influence or request settings that the user can make for himself.

Name MA*

Parameters

Return value

Description
SetSaveUpdatedWindowPosition INTEGER Sets whether to save changed window positions in the user settings
GetSaveUpdatedWindowPosition INTEGER Prompts whether changed window positions are saved in the user settings.
SetUseStoredWindowPositionOnOpen INTEGER Sets whether to open windows at the saved positions.
GetUseStoredWindowPositionOnOpen INTEGER Queries whether saved window positions are used when opening windows
DeleteStoredWindowPositions Deletes all saved Windows positions
GetShowStackOnError INTEGER Queries whether the contents of the IV stack should be displayed in case of an error
SetShowStackOnError INTEGER Determines whether the contents of the IV stack should be displayed in case of an error

Miscellaneous

Name MA*

Parameters

Return value

Description
CheckHash
196595
STRING, STRING, STRING INTEGERChecks whether a plaintext password matches a hash with specified algorithm and salt. Return truth value.
CreateUUID STRING This class function generates a Universally Unique Identifier(UUID). A 128-bit number that is used to uniquely identify information.
GenerateHash
196595
STRING, STRING, STRING STRING Forms a hash value according to specified algorithm and salt from the passed string.
Hash STRING STRING Forms a hash value according to SHA-1 from the passed string. The hash value is always 40 characters long (corresponds to 160 bits, represented in hexadecimal).
Log STRING, STRING, NOTIFICATION_LEVEL Logs the passed string to the specified logger with the passed log level.

LogError

STRING Logs the passed string on the logger cx.app with log level ERROR.
LogWarning STRING Logs the passed string on the logger cx.app with log level WARN
LogInfo
224620
STRING Logs the passed string on the logger cx.app with log level INFO.
LogDebug STRING Logs the passed string on the logger cx.app with log level DEBUG
LogTrace STRING Logs the passed string on the logger cx.app with log level TRACE
RandomDate OBJECT Generates a random date
RandomInt INTEGER, INTEGERINTEGER Generates a random number
TransformXML STRING xmlFile,
STRING xslFile,
STRING destFile
Converts any XML file (file name, valid for all parameters) into another format. The translation rule is stored in the XSL file by a script.
TestSysUnitTable INTEGER
ShowOOPSConsoleWindow
215995
TRUE/FALSE INTEGER Opens/closes the OOPS console

* MA = Member Access function, shaded grey = inherited function

Use in AppsWH
Module Brief description