DataAreaManager class | QSYS API Reference Guide
Estimated reading time: 7 minutes
Handles DataArea operations.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| DataAreaManager() | Creates a DataAreaManager object. |
DataAreaManager()
Creates a DataAreaManager object.
DataAreaManager()
Methods
| Signature | Description |
|---|---|
| In(String, Database, String, Boolean, Boolean, DataStructure) | Reads from a DataArea into a DataStructure. |
| In(String, Database, String, Boolean, Boolean) | Reads from a DataArea. |
| Out(String, Boolean, Char) | Writes a character value into a DataArea. |
| Out(String, Boolean, Decimal) | Writes a decimal number into a DataArea. |
| Out(String, Boolean, String) | Writes a character string into a DataArea. |
| Out(String, Boolean, DataStructure) | Writes a DataStructure object into a DataArea. |
| Out(String, Database, Char) | Writes a character into a DataArea. |
| Out(String, Database, Decimal) | Writes a decimal number into a DataArea. |
| Out(String, Database, String) | Writes a character string into a DataArea. |
| Out(String, Database, DataStructure) | Writes an DataStructure object into a DataArea. |
| Unlock(String) | Unlock a previously locked DataArea. |
| Unlock() | Unlock all the locked DataAreas in use. |
void In(string name, Database db, string path, bool isLock, bool isVar, DataStructure ds)
Reads from a DataArea into a DataStructure.
void In(string name, Database db, string path, bool isLock, bool isVar, DataStructure ds)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| String | path | DataArea Database location. |
| Boolean | isLock | True is locking should be performed; otherwise False. |
| Boolean | isVar | False if the name parameter is a literal. |
| DataStructure | ds | In ds param. |
object In(string name, Database db, string path, bool isLock, bool isVar)
Reads from a DataArea.
object In(string name, Database db, string path, bool isLock, bool isVar)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| String | path | DataArea Database location. |
| Boolean | isLock | True is locking should be performed; otherwise False. |
| Boolean | isVar | False if the name parameter is a literal. |
Returns
| Type | Description |
|---|---|
| Object | The value retrieved from the data area. |
void Out(string name, bool isLock, char value)
Writes a character value into a DataArea.
void Out(string name, bool isLock, char value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Boolean | isLock | If false it unlocks the DataArea; otherwise ignored. |
| Char | value | The character value to write into the DataArea. |
void Out(string name, bool isLock, decimal value)
Writes a decimal number into a DataArea.
void Out(string name, bool isLock, decimal value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Boolean | isLock | If false it unlocks the DataArea; otherwise ignored. |
| Decimal | value | The number to write into the DataArea. |
void Out(string name, bool isLock, string value)
Writes a character string into a DataArea.
void Out(string name, bool isLock, string value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Boolean | isLock | If false it unlocks the DataArea; otherwise ignored. |
| String | value | The character string to write into the DataArea. |
void Out(string name, bool isLock, DataStructure ds)
Writes a DataStructure object into a DataArea.
void Out(string name, bool isLock, DataStructure ds)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Boolean | isLock | If false it unlocks the DataArea; otherwise ignored. |
| DataStructure | ds | The DataStructure object to write into the DataArea. |
void Out(string name, Database db, char value)
Writes a character into a DataArea.
void Out(string name, Database db, char value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| Char | value | The new char value. |
void Out(string name, Database db, decimal value)
Writes a decimal number into a DataArea.
void Out(string name, Database db, decimal value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| Decimal | value | The new decimal value. |
void Out(string name, Database db, string value)
Writes a character string into a DataArea.
void Out(string name, Database db, string value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| String | value | The new string value. |
void Out(string name, Database db, DataStructure ds)
Writes an DataStructure object into a DataArea.
void Out(string name, Database db, DataStructure ds)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
| Database | db | Database instance. |
| DataStructure | ds | The DataStructure object to write into the DataArea. |
void Unlock(string name)
Unlock a previously locked DataArea.
void Unlock(string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | DataArea name. |
void Unlock()
Unlock all the locked DataAreas in use.
void Unlock()