GETINFO [ MPE/iX Intrinsics Reference Manual ] MPE/iX 5.0 Documentation
MPE/iX Intrinsics Reference Manual
GETINFO
NM and CM callable.
Returns user-supplied information that was passed to a process when it
was created.
Syntax
___________________________________________________
| |
| I16 CA I16 I16 |
| result:=GETINFO(infostring,infolength,parm);|
___________________________________________________
Functional Return
result 16-bit signed integer (assigned functional return)
Returns an execution value:
Value Meaning
0 Successful execution.
1 Execution error, one of the following conditions
exist:
* Infostring was specified, but infolength was
not specified.
* Infolength was specified, but infostring was
not specified.
* Either an invalid infostring or infolength
value was specified.
* An invalid parm value was specified.
Parameters
infostring character array (optional)
Returns an information string (the contents of an
array) passed to the calling process by the info
parameter of the RUN command, or by the item
associated with itemnum 11 of the CREATEPROCESS
intrinsic.
If the information string was not supplied at
process creation time, or if it is of length zero,
infostring is returned unmodified.
If infostring is specified, infolength must pass
the length, in bytes, of infostring.
infolength 16-bit signed integer by reference (optional)
Passes and receives a value.
If infostring is specified, infolength must pass
the length, in bytes, of infostring.
When returning from the call, infolength contains
the smaller of either the length of the information
string returned in infostring or the original value
of infolength.
NOTE Specify a value at least as large as the length of the information
string supplied at process creation time. If infolength is too
small, the information string is truncated upon return to
infostring.
Infostring and infolength must be specified as a pair.
parm 16-bit signed integer by reference (optional)
Returns a value passed to the calling process at
process creation time by one of the following
sources:
* The parm parameter of the RUN command.
* The item associated with itemnum 2 of the
CREATEPROCESS intrinsic.
* The param parameter of the CREATE intrinsic.
A zero is returned if none of the above are used to
pass a value.
Operation Notes
Returns user-supplied information to the calling process from one of the
following sources:
* If the process was created with the RUN command, the contents of
the info and parm parameters can be retrieved.
* If the process was created with the CREATEPROCESS intrinsic,
retrieve the items associated with itemnums 11 and 2.
* If the process was created with the CREATE intrinsic, retrieve the
contents of the param parameter.
Related Information
Intrinsics None
Commands None
Manuals Process Management Programmer's Guide (32650-90023)
MPE/iX 5.0 Documentation