Miscellaneous Functions

AreaCheck

Determines whether the current user has access to a specified area.

Assert

Verifies a particular condition is true, or halts the task.

Beep

Beeps the speaker or sound card in the computer.

CitectInfo

Gets information about a Plant SCADA variable.

CodeTrace

Traces Cicode into the Kernel and the SYSLOG.DAT file.

DebugBreak

Causes a breakpoint error to start the Cicode Debugger.

DebugMsg

In-line debug messages of user Cicode.

DebugMsgSet

Enables/disables the DebugMsg function.

DelayShutdown

Causes Plant SCADA to shut down after a specified period

DisplayRuntimeManager

Starts and displays Plant SCADA Runtime Manager.

DumpKernel

Dumps Kernel data to the Kernel.dat file.

EngToGeneric

Converts a variable into generic scale format.

Exec

Executes an application or PIF file.

GetArea

Gets the current viewable areas.

GetEnv

Gets an environment variable.

GetLogging

Gets the current value for one or more logging parameters.

InfoForm

Displays graphics object help information for the AN closest to the cursor.

InfoFormAn

Displays graphics object help information for an AN.

Input

Gets text input from the operator.

IntToReal

Converts an integer variable into a real (floating point) number.

KerCmd

Executes a command in a kernel window.

KernelQueueLength

Obtains the number of rows in a queue.

KernelTableInfo

Provides a consistent method of accessing items within a Kernel Table.

KernelTableItemCount

Obtains the number of rows in a Kernel Table.

LanguageFileTranslate

Translates an ASCII file into the local language.

Message

Displays a message box on the screen.

ParameterGet

Gets the value of a system parameter.

ParameterPut

Updates a system parameter.

ProcessIsClient

Determines if the currently executing process contains a Client component.

ProcessIsServer

Determines if the currently executing process contains a particular server component.

ProcessRestart

Restarts the current process in which Cicode is running.

ProductInfo

Returns information about the Plant SCADA product.

ProjectInfo

Returns information about a particular project, which is identified by a project enumerated number.

ProjectRestartGet

Gets the path to the project to be run the next time Plant SCADA is restarted.

ProjectRestartSet

Sets the path to the project to be run the next time Plant SCADA is restarted.

ProjectSet

Sets the name or path of the current project.

Prompt

Displays a message in the prompt line.

Pulse

Pulses (jogs) a variable tag every two seconds.

ServerDumpKernel

Dumps Kernel data to the KERNEL.DAT file either on a local server or on a remote server.

ServiceGetList

Gets information about services running in the component calling this function.

SetArea

Sets the current viewable areas.

SetLanguage

This function is now obsolete.

SetLogging

Adjusts logging parameters while online.

Shutdown

Ends Plant SCADA's operation.

ShutdownForm

Displays a form that allows an operator to shut down the Plant SCADA system.

ShutdownMode

Gets the mode of the shutdown/restart.

SwitchConfig

Switches focus to the Plant SCADA configuration application.

TestRandomWave

Generates a random wave.

TestSawWave

Generates a saw wave.

TestSinWave

Generates a sine wave.

TestSquareWave

Generates a square wave.

TestTriangWave

Generates a triangular wave.

Toggle

Toggles a digital tag on or off.

TraceMsg

Displays a message in the Kernel and Debugger debug windows.

Version

Gets the version number of the Plant SCADA software.