IDS interface | QSYS API Reference Guide

Estimated reading time: 2 minutes

Defines the basic set of operations for a data structure.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll

Extends: doesn’t extend any other interfaces.

Properties

Type	Name	Description
List<IDSField>	BufferDescription	Returns the flat description of the data structure buffer.
String	DSName	Gets the name of the data structure.
List<IDSField>	Fields	Gets the fields composing the data structure.
Int32	Length	Gets the length of the data structure.

Signature	Description
Clear()	Clears the data structure.
Dump()	Gats the data structure contents as a string.
Load(String)	Loads the data structure from a string.
ObjectToParm(As400Program, Int32[], Int32)	Converts the Data Structure field values into parameters for calling the given IBMi program.
ParmToObject(As400Program, Int32[], Int32)	Gets the data structure field values returned from a call to an IBMi program.

Clears the data structure.

void Clear()

Gats the data structure contents as a string.

string Dump()

Loads the data structure from a string.

void Load(string source)

Type	Parameter name	Description
String	source	The string to copy into the data structure.

Converts the Data Structure field values into parameters for calling the given IBMi program.

void ObjectToParm(As400Program program, Int32[] indices, int dimensions)

Type	Parameter name	Description
As400Program	program	As400Program object describing the program call.
Int32[]	indices	Array that hold the indices for the current parameter.
Int32	dimensions	The dimension nesting of the parameter.

Gets the data structure field values returned from a call to an IBMi program.

void ParmToObject(As400Program program, Int32[] indices, int dimensions)

Type	Parameter name	Description
As400Program	program	As400Program object describing the program call.
Int32[]	indices	Array that hold the indices for the current parameter.
Int32	dimensions	The dimension nesting of the parameter.