AS/400 Toolbox for Java \ PCML \ PCML syntax \ Program tag

The program tag

The program tag can be expanded with the following elements:
<program name="name"
    Start change[ entrypoint="entry-point-name" ] End change    [ path="path-name" ]
    [ parseorder="name-list" ] >
    Start change[ returnvalue="{ void | integer }" ]End change</program>
Attribute Value Description
Start change entrypoint= entry-point-name Specifies the name of the entry point within a service program object that is the target of this program call.End change
name= name Specifies the name of the program.
path= path-name Specifies the path to the program object.
The default value is to assume the program is in the QSYS library.

Start changeThe path must be a valid IFS path name to a *PGM or *SRVPGM object. If a *SRVPGM object is called, the entrypoint attribute must be specified to indicate the name of the entrypoint to be called.

If the entrypoint attribute is not specified, the default value for this attribute is assumed to be a *PGM object from the QSYS library. If the entrypoint attribute is specified, the default value for this attribute is assumed to be a *SRVPGM object in the QSYS library.

The path name should be specified as all uppercase characters.End change

parseorder= name-list Specifies the order in which output parameters will be processed. The value specified is a blank separated list of parameter names in the order in which the parameters are to be processed. The names in the list must be identical to the names specified on the name attribute of tags belonging to the <program>. The default value is to process output parameters in the order the tags appear in the document.

Some programs return information in one parameter that describes information in a previous parameter. For example, assume a program returns an array of structures in the first parameter and the number of entries in the array in the second parameter. In this case, the second parameter must be processed in order for the ProgramCallDocument to determine the number of structures to process in the first parameter.

Start change returnvalue= void
The program does not return a value.

integer
The program returns a 4-byte signed integer.

Specifies the type of value, if any, that is returned from a service program call. This attribute is not allowed for *PGM object calls.End change

[ Information Center Home Page | Feedback ] [ Legal | AS/400 Glossary ]