IDataArea interface | QSYS API Reference Guide
Estimated reading time: 11 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. |
void AppendParm(ProgParm Parameter)
Appends a ProgParm parameter to the data area.
void AppendParm(ProgParm Parameter)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Parameter | The ProgParm parameter to append. |
void Change(bool Value)
Changes the value of the data area to a boolean value.
void Change(bool Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | Value | The boolean value to set. |
void Change(decimal Value)
Changes the value of the data area to a decimal value.
void Change(decimal Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Decimal | Value | The decimal value to set. |
void Change(string Value)
Changes the value of the data area to a string value.
void Change(string Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | Value | The string value to set. |
void Change(string Value, int StartingOffset, int SubstringLength)
Changes a subset of the data area to a string value.
void Change(string Value, int StartingOffset, int SubstringLength)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | Value | The string value to set. |
| Int32 | StartingOffset | The starting offset of the subset. |
| Int32 | SubstringLength | The length of the subset. |
void Change(ProgParm Value)
Changes the value of the data area to a ProgParm value.
void Change(ProgParm Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Value | The ProgParm value to set. |
void Change(ProgParm Value, int StartingOffset, int SubstringLength)
Changes a subset of the data area to a ProgParm value.
void Change(ProgParm Value, int StartingOffset, int SubstringLength)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Value | The ProgParm value to set. |
| Int32 | StartingOffset | The starting offset of the subset. |
| Int32 | SubstringLength | The length of the subset. |
void ObjectToParm(object Value, string ParameterName)
Converts an object to a ProgParm parameter and assigns it to the data area.
void ObjectToParm(object Value, string ParameterName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Object | Value | The object to convert. |
| String | ParameterName | The name of the ProgParm parameter. |
void ObjectToParm(ProgParm Parameter, object Value)
Converts an object to a ProgParm parameter and assigns it to the data area.
void ObjectToParm(ProgParm Parameter, object Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Parameter | The ProgParm parameter to assign to. |
| Object | Value | The object to convert. |
void ObjectToParm(ProgParm Parameter, object Value, int Element)
Converts an object to a ProgParm parameter and assigns it to the data area.
void ObjectToParm(ProgParm Parameter, object Value, int Element)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Parameter | The ProgParm parameter to assign to. |
| Object | Value | The object to convert. |
| Int32 | Element | The element index in the ProgParm parameter. |
void ObjectToParm(object Value, string ParameterName, Int32[] ElementIndices)
Converts an object to a ProgParm parameter and assigns it to the data area.
void ObjectToParm(object Value, string ParameterName, Int32[] ElementIndices)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Object | Value | The object to convert. |
| String | ParameterName | The name of the ProgParm parameter. |
| Int32[] | ElementIndices | The element indices in the ProgParm parameter. |
object ParmToObject(Type ReturnType, string ParameterName)
Converts a ProgParm parameter to an object.
object ParmToObject(Type ReturnType, string ParameterName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Type | ReturnType | The type to convert to. |
| String | ParameterName | The name of the ProgParm parameter. |
Returns
| Type | Description |
|---|---|
| Object | The converted object. |
object ParmToObject(ProgParm Parameter, Type ReturnType)
Converts a ProgParm parameter to an object.
object ParmToObject(ProgParm Parameter, Type ReturnType)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Parameter | The ProgParm parameter to convert. |
| Type | ReturnType | The type to convert to. |
Returns
| Type | Description |
|---|---|
| Object | The converted object. |
object ParmToObject(ProgParm Parameter, Type ReturnType, int Element)
Converts a ProgParm parameter to an object.
object ParmToObject(ProgParm Parameter, Type ReturnType, int Element)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Parameter | The ProgParm parameter to convert. |
| Type | ReturnType | The type to convert to. |
| Int32 | Element | The element index in the ProgParm parameter. |
Returns
| Type | Description |
|---|---|
| Object | The converted object. |
object ParmToObject(Type ReturnType, string ParameterName, Int32[] ElementIndices)
Converts a ProgParm parameter to an object.
object ParmToObject(Type ReturnType, string ParameterName, Int32[] ElementIndices)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Type | ReturnType | The type to convert to. |
| String | ParameterName | The name of the ProgParm parameter. |
| Int32[] | ElementIndices | The element indices in the ProgParm parameter. |
Returns
| Type | Description |
|---|---|
| Object | The converted object. |
object Retrieve()
Retrieves the value of the data area.
object Retrieve()
string Retrieve(int StartingOffset, int SubstringLength)
Get a subset of the data in a character-type data area.
string Retrieve(int StartingOffset, int SubstringLength)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32 | StartingOffset | 0-based index of first character of the subset. |
| Int32 | SubstringLength | The non-negative length of the subset. |
Returns
| Type | Description |
|---|---|
| String | The specified subset as a string, or null if the dataarea is not a character type. |
void Retrieve(ProgParm Value)
Retrieves the value of the data area into a ProgParm value.
void Retrieve(ProgParm Value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Value | The ProgParm value to retrieve into. |
void Retrieve(ProgParm Value, int StartingOffset, int SubstringLength)
Retrieves a subset of the data area into a ProgParm value.
void Retrieve(ProgParm Value, int StartingOffset, int SubstringLength)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ProgParm | Value | The ProgParm value to retrieve into. |
| Int32 | StartingOffset | The starting offset of the subset. |
| Int32 | SubstringLength | The length of the subset. |
void SetInitialValue(string value)
Sets the initial value of the data area.
void SetInitialValue(string value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | value | The initial value to set. |