iPgm
- class iPgm(pgm, options)
Note
Deprecated: Replaced by
ProgramCall
and will be removed in the next major version.Creates a new iPgm object.
- Arguments
pgm (string) – The program or service program name.
options (iPgmOptions) –
- iPgm.addParam(data, type, options)
Note
Deprecated: Replaced by
ProgramCall.addParam()
and will be removed in the next majorversion.
Adds a parameter to the program.
- Arguments
data (string|array) – The value of the the data or 2D array ds definition.
type (string|object) – The XMLSERVICE data type or ds options.
options (object) – The parm or data options.
- iPgm.addReturn(data, type, options)
Note
Deprecated: Replaced by
ProgramCall.addReturn()
and will be removed in thenext major version.
Specifies the type of the return value from the service program function.
- Arguments
data (string) – The value of the data.
type (string) – The xmlservice data type.
options (object) – The data options.
- iPgm.toXML()
Note
Deprecated: Replaced by
ProgramCall.toXML()
and will be removed in the next major version.- Returns
string – The generated program XML.
- iPgmOptions()
iPgm Options
- Arguments
lib (string) – The library where the program exists.
error (string) – Determines action when an error is encountered. Valid options are
on
,off
, orfast
. Default isfast
. Usingon
will cause the script execution to stop and log a full error report. Usingoff
orfast
continues executing the script. The Difference is thatfast
will log a brief error report andoff
will not.func (string) – The target function of the service program.