LocalScopeMultiDS<T> class
Estimated reading time: 5 minutes
Contains functionality to support locally scoped multiple occurrence data structures. A LocalScopeMultiDS object contains an array of LocalScopeDS objects.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Remarks
Locally scoped multiple occurrence data structures encapsulate a collection of LocalScopeDS objects that provide the buffer functionality. Access to the buffer is via the field properties of the current occurrence object.
Constructors
| Name | Description |
|---|---|
| LocalScopeMultiDS(Int32) | Constructs a one-dimensional LocalScopeMultiDS of the given array length. |
LocalScopeMultiDS(Int32)
Constructs a one-dimensional LocalScopeMultiDS of the given array length.
LocalScopeMultiDS(Int32)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Int32 | arrayLength | Length of the LocalScopeMultiDS. |
Properties
| Type | Name | Description |
|---|---|---|
| List<IDSField> | BufferDescription | Returns the flat description of the data structure buffer. |
| T | Current | Gets the current occurrence of this multiple occurrence data structure. |
| String | DSName | Gets the name of the current occurrence. |
| List<IDSField> | Fields | Gets the layout of the current occurrence. |
| T | Item | Gets the LocalScopeDS 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(LocalScopeMultiDS<T>) | Casting operator to string. Returns the multi-occurrence data structure as a string. |
| op_Implicit(LocalScopeMultiDS<T>) | Cast operator to type T. 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. |
| ToT() | Get the current occurrence. |
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(LocalScopeMultiDS<T> multiDataStructure)
Casting operator to string. Returns the multi-occurrence data structure as a string.
string op_Explicit(LocalScopeMultiDS<T> multiDataStructure)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| LocalScopeMultiDS<T> | multiDataStructure | Multi-occurrence data structure to cast to string. |
Returns
| Type | Description |
|---|---|
| String |
T op_Implicit(LocalScopeMultiDS<T> multiDS)
Cast operator to type T. Returns the current occurrence.
T op_Implicit(LocalScopeMultiDS<T> multiDS)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| LocalScopeMultiDS<T> | multiDS | The local multi data structure. |
Returns
| Type | Description |
|---|---|
| T |
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()
T ToT()
Get the current occurrence.
T ToT()