SVALA

Concept Link IconSee also Concept Link IconExample Concept Link IconFurther information

Extraction of alarm information.

WebVue support - Yes.

Mode

Mnemonic

Syntax
1 EXTRACT 1
2 COUNT 2

Only one extraction can be processed at a time across user sessions. The application developer shall make sure the value of the asynchronous result variable is different from -9 (a request is in progress) before starting an extraction.

In addition, SVALA execution is not protected at the user session level, e.g. all sessions have access to the data extracted by another session if buffer handles are global.

Syntax 1

IntVal = SVALA(Mode, DestHandle, ParamHandle [,EndVarName, Sense] [, CountVarName]);

Return type: INTEGER

Argument

Meaning

DestHandle

The handle of a buffer in which the retrieved alarms will be placed. Type LONG.

ParamHandle

The handle of a buffer that contains parameters that will be used to filter the alarms to be extracted. The parameters take the format of a comma-separated string. Type LONG.

EndVarName

The name of a database bit variable that will be set to the value contained in Sense when the extract has finished. Type STR.

Sense

A flag (0 or 1) which will be written into the variable EndVarName when the extract has finished. Any numeric type.

CountVarName

The name of a database register variable into which will be placed the number of alarms extracted. Type STR.

Execution

Mode

Mnemonic

Action

1

EXTRACT

Alarms passing the filter criteria are extracted and placed in the buffer defined by the parameter DestHandle.

 

 

Return values:

1 The instruction was executed successfully.
0 The mode is incorrect.
-1 The parameter DestHandle is incorrect.
-2 The parameter ParamHandle is incorrect.
-3 The content pointed to by ParamHandle is incorrect.
-4 The variable EndVarName does not exist.
-5 The variable EndVarName cannot be written to.
-5 The variable EndVarName cannot be written to.
-6 The parameter Sense does not exist or has an incorrect value.
-7 The variable CountVarName does not exist.
-8 The variable CountVarName cannot be written to.
-9 A request is in progress.

Syntax 2

IVal = SVALA(Mode, ParamHandle [,EndVarName, Sense] [, CountVarName]);

Return type: INTEGER.

Execution

Mode

Mnemonic

Action

2

COUNT

Alarms passing the filter criteria are counted and the result placed in the variable CountVarName.

 

 

Return values:

1 The instruction was executed successfully.
0 The mode is incorrect.
-1 The parameter DestHandle is incorrect.
-2 The parameter ParamHandle is incorrect.
-3 The content pointed to by ParamHandle is incorrect.
-4 The variable EndVarName does not exist.
-5 The variable EndVarName cannot be written to.
-6 The parameter Sense does not exist or has an incorrect value.
-7 The variable CountVarName does not exist.
-8 The variable CountVarName cannot be written to.
-9 A request is in progress.

For the format of the parameter buffer, see the topic Parameter Buffer Format and the topic on Native Filter Expressions.

Example

For an example, select the Example link above.