|
The parameter descriptions are listed in alphabetical order. Default
values are underlined. - ,COMPCODE=0
- ,COMPCODE=compcode
- Use this input parameter to specify a user-defined completion
code value. When the sync point is reached, the system presents the
highest completion code that was set by any confirming connector to
the event exit. The system provides a default value of zero if you
do not specify a completion code value.
For connectors that fail
or disconnect at a time that they owe a user sync point confirmation,
the system confirms the sync point with a completion code of IXLUSYNCFAILEDUSERCOMPCODE
(X'0000FFFF'). Thus, if a given user completion code is to
take precedence over the completion code set by the system, the user
completion code must be greater than X'0000FFFF'. Similarly,
if the completion code set by the system is to take precedence over
a user completion code, the user completion code must be less than
IXLUSYNCFAILEDUSERCOMPCODE (X'0000FFFF').
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
fullword input field that contains the user-defined completion code
value.
- ,CONTOKEN=contoken
- Use this input parameter to specify the original connect token
returned to the requestor from the IXLCONN macro. The IXLCONN macro
allows the requestor to connect to the structure.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
16-character input field that contains the connect token returned
to the requestor when connecting to the structure with IXLCONN.
- ,MF=S
- ,MF=(L,mfctrl)
- ,MF=(L,mfctrl,mfattr)
- ,MF=(L,mfctrl,0D)
- ,MF=(E,mfctrl)
- ,MF=(E,mfctrl,COMPLETE)
- Use MF=S to specify the standard form of the macro, which builds
an inline parameter list and generates the macro invocation to transfer
control to the service.
Use MF=L to specify the list form of the macro. Use the list form
together with the execute form of the macro for applications that
require reentrant code. The list form defines an area of storage that
the execute form uses to store the parameters. Only the PLISTVER parameter
can be coded with the list form of the macro.
Use MF=E to specify the execute form of the macro. Use the execute
form together with the list form of the macro for applications that
require reentrant code. The execute form stores the parameters into
the storage area defined by the list form, and generates the macro
invocation to transfer control to the service.
- ,mfctrl
- Use this output parameter to specify a storage area to contain
the parameters.
To Code: Specify the RS-type name or address (using a register
from 2 to 12) of the parameter list.
- ,mfattr
- Use this input parameter to specify the name of a 1- to 60-character
string that can contain any value that is valid on an assembler DS
pseudo-op. You can use this parameter to force boundary alignment
of the parameter list. If you do not code mfattr, the system
provides a value of 0D, which forces the parameter list to a doubleword
boundary.
- ,COMPLETE
- Use this input parameter to require that the system check for
required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional
parameters that are not documented here. The ones that are not documented
do not have any effect on the macro. For example, if SMILE=var were
an optional parameter and the default is SMILE=NO_SMILE then it would
not be documented. However, if the default was SMILE=:-), then it
would be documented because a value would be the default.
- ,NEXTUSEREVENT=nextuserevent
- Use this input/output parameter to specify a value associated
with the next user event to be set. The NEXTUSEREVENT value must be
non-zero.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of a fullword input/output field to
contain the value associated with the next user event.
- ,PROXYRESPONSE=NO
- ,PROXYRESPONSE=YES
- Use this input parameter to indicate whether this response is
being provided on behalf of a failing connector.
- NO
- Indicates that this is not a proxy response. The response is
on behalf of the connector described by the CONTOKEN keyword.
- YES
- Indicates that this in a proxy response. The response is being
provided on behalf of the connector described by the SUBJCONTOKEN
keyword.
Note: To ensure that the PROXYRESPONSE feature
is installed on the system on which you are running, issue IXCQUERY
REQINFO=FEATURES. QUREQRFPROXYRESPONSE, returned from the IXCQUERY
request, indicates whether the PROXYRESPONSE feature is installed.
- ,RETCODE=retcode
- Use this output parameter to specify the location in which the
system is to copy the return code from GPR 15.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
to contain the return code.
- ,REQUEST=SET
- ,REQUEST=CONFIRM
- ,REQUEST=CONFIRMSET
- Use this input parameter to identify the type of user sync point
request. You can set a user event, confirm that processing is complete
for a user event, or confirm that processing is complete and then
set the next user event. Only one user event can be set at a time.
- SET
- Set the user event. When setting an event, a previous event, if
there was one, must have been confirmed by all connectors and all
connectors must have been told about the completion of the user sync
point through their event exit. If the user event is successfully
set, the User Sync Point event is presented to the event exit of each
connector. The following information is presented to each connector
in the event exit parameter list (IXLYEEPL):
- EEPLCOMPLETEDUSEREVENT — set to zero.
- EEPLNEXTUSEREVENT — set to the value specified by the USEREVENT
keyword.
- EEPLCOMPLETEDUSERSTATE — set to zero.
- EEPLNEXTUSERSTATE — set to the value specified by the USERSTATE
keyword or zero if USERSTATE is not specified.
- EEPLCOMPLETEDUSERCOMPCODE — set to zero.
- CONFIRM
- Confirm a user event specified by the USEREVENT keyword. When
all connectors have confirmed the event and their confirmations have
been received, the system presents the User Sync Point event to the
event exit of each connector to indicate that a user sync point has
been reached. The following information is presented to each connector
in the event exit parameter list (IXLYEEPL):
- EEPLCOMPLETEDUSEREVENT — set to the value specified by the USEREVENT
keyword.
- EEPLNEXTUSEREVENT — set to zero.
- EEPLCOMPLETEDUSERSTATE — set to the value specified when the event
was set (with the USERSTATE keyword).
- EEPLNEXTUSERSTATE — set to zero.
- EEPLCOMPLETEDUSERCOMPCODE — set to the highest user completion
code value that was specified by any confirming connector. Note that
if a connector fails or disconnects while XES is expecting a user
sync point confirmation from that connector, XES confirms the event
for the failing connector with a completion code of IXLUSYNCFAILEDUSERCOMPCODE
(X'0000FFFF').
- CONFIRMSET
- Confirm the user event specified by the USEREVENT keyword, and
if this is the last confirmation for the event, set the next user
event to the value specified by the NEXTUSEREVENT keyword. If this
is not the last confirmation for the event, the “set” is ignored.
When all confirmations have been received, the system presents
the User Sync Point event to the event exit of each connector indicating
that a sync point has been reached. In the same parameter list, the
next user event also is presented to each connector. The following
information is presented to each connector in the event exit parameter
list (IXLYEEPL): - EEPLCOMPLETEDUSEREVENT — set to the value specified by the USEREVENT
keyword.
- EEPLNEXTUSEREVENT — set to the value specified by the NEXTUSEREVENT
keyword.
- EEPLCOMPLETEDUSERSTATE — set to the user state specified by the
connector that set the original event.
- EEPLNEXTUSERSTATE — set to the value specified by the USERSTATE
keyword or zero if USERSTATE is not specified.
- EEPLCOMPLETEDUSERCOMPCODE — set to the highest user completion
code value that was specified by any confirming connector. Note that
if a connector fails or disconnects while XES is expecting a user
sync point confirmation from that connector, XES confirms the event
for the failing connector with a completion code of IXLUSYNCFAILEDUSERCOMPCODE
(X'0000FFFF').
- ,RSNCODE=rsncode
- Use this output parameter to specify the location in which the
system is to copy the reason code from GPR 0.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of a fullword
to contain the reason code.
- ,SUBJCONTOKEN=subjcontoken
- Use this input parameter to identify the connector for whom the
response is being provided. The subject connector must be in the
failing state.
Do not provide a proxy response on behalf of a
failing connector until AFTER the EEPLDISCFAILCONNECTION event for
the subject user has been presented to your event exit. You can use
the value of the EEPLSUBJCONTOKEN field from that invocation of the
event exit as input for this parameter.
Note that if the subject
connector is not in the failing state, the IXLUSYNC request will fail
with the IXLRSNCODESUBJCONNNOTFAILING reason code.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
16-character input field that contains the connect token for which
the response is being provided.
- ,USEREVENT=userevent
- Use this input parameter to specify the user event associated
with this request. The value of USEREVENT must be non-zero.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the fullword input/output field that contains the value
associated with the user event.
- ,USERSTATE=ALL_ZEROES
- ,USERSTATE=userstate
- Use this input/output parameter to specify a user-defined value
to be presented to the event exit. If this value is not provided,
the field is set to the default of all zeroes. The user state presented
to the event exit is that set by the connector that successfully set
the user event.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of a 32-character input/output field
that contains the user-defined value associated with the event that
is to be presented to the event exit.
|