IDataArea interface
Estimated reading time: 2 minutes
Defines the contract for managing a data area in the ASNA DataGate client.
Namespace: ASNA.DataGate.Client Assembly: ASNA.QSys.DataGate.Client.dll
Extends: IAdgObject, IComparable, IConnectionHandler, IDisposable
Remarks
This interface provides properties and methods to manage a data area in the ASNA DataGate client. It includes properties to get and set the length and number of decimal places of the data area, methods to set the initial value, change the value, retrieve the value, and convert between ProgParm parameters and objects.
Properties
| Type | Name | Description |
|---|---|---|
| Int32 | Decimals | Gets or sets the number of decimal places in the data area. The number of decimals can be between 0 and 9. |
| Int32 | Length | Gets or sets the length of the data area. The length can be between 1 and 2000. |
Methods
| Signature | Description |
|---|---|
| AppendParm(ProgParm) | Appends a ProgParm parameter to the data area. |
| Change(Boolean) | Changes the value of the data area to a boolean value. |
| Change(Decimal) | Changes the value of the data area to a decimal value. |
| Change(String) | Changes the value of the data area to a string value. |
| Change(String, Int32, Int32) | Changes a subset of the data area to a string value. |
| Change(ProgParm) | Changes the value of the data area to a ProgParm value. |
| Change(ProgParm, Int32, Int32) | Changes a subset of the data area to a ProgParm value. |
| ObjectToParm(Object, String) | Converts an object to a ProgParm parameter and assigns it to the data area. |
| ObjectToParm(ProgParm, Object) | Converts an object to a ProgParm parameter and assigns it to the data area. |
| ObjectToParm(ProgParm, Object, Int32) | Converts an object to a ProgParm parameter and assigns it to the data area. |
| ObjectToParm(Object, String, Int32[]) | Converts an object to a ProgParm parameter and assigns it to the data area. |
| ParmToObject(Type, String) | Converts a ProgParm parameter to an object. |
| ParmToObject(ProgParm, Type) | Converts a ProgParm parameter to an object. |
| ParmToObject(ProgParm, Type, Int32) | Converts a ProgParm parameter to an object. |
| ParmToObject(Type, String, Int32[]) | Converts a ProgParm parameter to an object. |
| Retrieve() | Retrieves the value of the data area. |
| Retrieve(Int32, Int32) | Get a subset of the data in a character-type data area. |
| Retrieve(ProgParm) | Retrieves the value of the data area into a ProgParm value. |
| Retrieve(ProgParm, Int32, Int32) | Retrieves a subset of the data area into a ProgParm value. |
| SetInitialValue(String) | Sets the initial value of the data area. |