MultiDataStructure class | QSYS API Reference Guide
Estimated reading time: 6 minutes
Contains functionality to support multiple occurrence data structures.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Remarks
Multiple occurrence data structures encapsulate a collection of data structure objects that provide the buffer functionality. Access to the buffer is via the class field properties operating on the current occurrence object.
Constructors
| Name | Description |
|---|---|
| MultiDataStructure(Int32, Int32) | Constructs a unidimensional MultiDataStructure object. |
| MultiDataStructure(Int32, ILayout[]) | Constructs a unidimensional MultiDataStructure object. |
| MultiDataStructure(Int32[], Int32) | Constructs a MultiDataStructure object. |
| MultiDataStructure(Int32[], ILayout[]) | Constructs a MultiDataStructure object. |
MultiDataStructure(Int32, Int32)
Constructs a unidimensional MultiDataStructure object.
MultiDataStructure(Int32, Int32)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32 | arrayLength | Number of elements in the multi data structure. |
| Int32 | size | Size of the individual data structures. |
MultiDataStructure(Int32, ILayout[])
Constructs a unidimensional MultiDataStructure object.
MultiDataStructure(Int32, ILayout[])
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32 | arrayLength | Number of elements in the multi data structure. |
| ILayout[] | fields | An ILayout array of field descriptions. |
MultiDataStructure(Int32[], Int32)
Constructs a MultiDataStructure object.
MultiDataStructure(Int32[], Int32)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32[] | arrayLength | Number of elements in all dimensions of the multi data structure. |
| Int32 | size | Size of the individual data structures. |
MultiDataStructure(Int32[], ILayout[])
Constructs a MultiDataStructure object.
MultiDataStructure(Int32[], ILayout[])
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32[] | arrayLength | Number of elements in all dimensions of the multi data structure. |
| ILayout[] | fields | An ILayout array of field descriptions. |
Properties
| Type | Name | Description |
|---|---|---|
| Int32[] | ArrayLength | Length of the multi data structure in all dimensions. |
| List<IDSField> | BufferDescription | Returns the flat description of the data structure buffer. |
| DataStructure | Current | Gets the current occurrence of this multiple occurrence data structure. |
| String | DSName | Gets the name of this multi data structure. |
| List<IDSField> | Fields | Layout of the individual data structures, if it exists. |
| DataStructure | Item | Gets the DataStructure object at the given index. |
| Int32 | ItemLength | Gets the length of the individual data structures in this MODS. |
| Int32 | Length | Gets the length of the multi occurrence data structure. |
| Int32[] | Occurrence | Gets the indices of the current occurrence of the multi data structure. |
Methods
| Signature | Description |
|---|---|
| Clear() | Clears the current occurrence. |
| ClearAll() | Clears all occurrences of the data structure. |
| Dump() | Gats the contents of the current occurrence as a string. |
| DumpAll() | Gets the contents of all occurrences of the multi data structure as a string. |
| Load(String) | Loads the current occurrence from a string. |
| LoadAll(String) | Copies the given string into the multi-occurrence data structure. |
| ObjectToParm(As400Program, Int32[], Int32) | IDS.ObjectToParm implementation. Converts the current occurrence field values into parameters for calling the given IBMi program. |
| op_Explicit(MultiDataStructure) | Casting operator to string. Returns the multi-occurrence data structure as a string. |
| op_Implicit(MultiDataStructure) | Cast operator to DataStructure. Returns the current occurrence. |
| ParmToObject(As400Program, Int32[], Int32) | IDS.ParmToObject implementation. Gets the current occurrence field values returned from a call to an IBMi program. |
| ToString() | Gets the contents of all occurrences of the multi data structure as a string. |
void Clear()
Clears the current occurrence.
void Clear()
void ClearAll()
Clears all occurrences of the data structure.
void ClearAll()
string Dump()
Gats the contents of the current occurrence as a string.
string Dump()
string DumpAll()
Gets the contents of all occurrences of the multi data structure as a string.
string DumpAll()
void Load(string source)
Loads the current occurrence from a string.
void Load(string source)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | source | The string to copy into the current occurrence. |
void LoadAll(string source)
Copies the given string into the multi-occurrence data structure.
void LoadAll(string source)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | source | The string to copy. |
void ObjectToParm(As400Program program, Int32[] indices, int dim)
IDS.ObjectToParm implementation. Converts the current occurrence field values into parameters for calling the given IBMi program.
void ObjectToParm(As400Program program, Int32[] indices, int dim)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| As400Program | program | As400Program object describing the program call. |
| Int32[] | indices | Array that hold the indices for the current parameter. |
| Int32 | dim | The dimension nesting of the parameter. |
string op_Explicit(MultiDataStructure multiDataStructure)
Casting operator to string. Returns the multi-occurrence data structure as a string.
string op_Explicit(MultiDataStructure multiDataStructure)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| MultiDataStructure | multiDataStructure | Multi-occurrence data structure to cast to string. |
Returns
| Type | Description |
|---|---|
| String |
DataStructure op_Implicit(MultiDataStructure mods)
Cast operator to DataStructure. Returns the current occurrence.
DataStructure op_Implicit(MultiDataStructure mods)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| MultiDataStructure | mods | The multi data structure. |
Returns
| Type | Description |
|---|---|
| DataStructure |
void ParmToObject(As400Program program, Int32[] indices, int dim)
IDS.ParmToObject implementation. Gets the current occurrence field values returned from a call to an IBMi program.
void ParmToObject(As400Program program, Int32[] indices, int dim)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| As400Program | program | As400Program object describing the program call. |
| Int32[] | indices | Array that hold the indices for the current parameter. |
| Int32 | dim | The dimension nesting of the parameter. |
string ToString()
Gets the contents of all occurrences of the multi data structure as a string.
string ToString()