EZBREIFR parameters

RequestResponseBuffer

Supplied parameter.

Type:

Character

Length:

Variable

The name of the storage area that contains an input request. The input request must be in the format of a request header (NMSHeader), as specified in the EZBRENMC header file. When the request completes successfully, the storage contains an output response in the same format.

RequestResponseBufferAlet

Supplied parameter.

Type:

Integer

Length:

Fullword

The name of a fullword that contains the access list entry token (ALET) of the RequestResponseBuffer parameter. If a nonzero ALET is specified, the ALET must represent a valid entry in the dispatchable unit access list (DU-AL) of the caller.

RequestResponseBufferLength

Supplied parameter.

Type:

Integer

Length:

Fullword

The name of a fullword that contains the length of request/response buffer.

If the buffer length is too short to contain all of the requested information, the request fails with the return code ENOBUFS. The length that is required to contain all of the information is provided in the NMSHBytesNeeded field of the NMSHeader data structure of the response. If the buffer length is not the minimum size for the request, the request fails with the return code ENOBUFS; however, the value that is required is not provided in the NMSHBytesNeeded field. The minimum size is the length of the NMSHeader data structure.

ReturnValue

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBREIFR service returns one of the following:

0 or positive integer, if the request is successful. A value greater than 0 specifies the number of output data bytes copied to the response buffer. See Resolver NMI: Request and response formats for additional details about processing request completions.
-1, if the request is not successful.

ReturnCode

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBREIFR service stores the return code (errno). The EZBREIFR service returns the ReturnCode parameter only if the ReturnValue value is -1.

ReasonCode

Returned parameter.

Type:

Integer

Length:

Fullword

The name of a fullword in which the EZBREIFR service stores the reason code (errnojr). The EZBREIFR service returns the ReasonCode parameter only if the ReturnValue value is -1. The ReasonCode parameter further qualifies the ReturnCode value.

The EZBREIFR service sets the return codes and reason codes described in Table 1. See z/OS UNIX System Services Messages and Codes for the hexadecimal values of the return and reason codes.

Table 1. EZBREIFR service return codes and reason codes
ReturnValue	ReturnCode	ReasonCode	Meaning
0	0	0	The request was successful.
-1	ENOBUFS	JRBuffTooSmall	The request was not successful. The request/response buffer is too small to contain all of the requested information. Some of the requested information might be returned. If the buffer was large enough for a complete NMSHeader to be returned, the NMSHeader NMSHBytesNeeded field might contain the buffer size to return all of the requested information. See the description of the RequestResponseBufferLength parameter for an explanation of when the NMSHBytesNeeded value is provided.
-1	EACCES	JRSAFNotAuthorized	The request was not successful. The caller is not authorized.
-1	EAGAIN	JRInactive	The request was not successful. The resolver is not active.
-1	EFAULT	JRReadUserStorageFailed	The request was not successful. A program check occurred while copying input parameters or while copying input data from the request/response buffer.
-1	EFAULT	JRWriteUserStorageFailed	The request was not successful. A program check occurred while copying output parameters or while copying output data to the request/response buffer.
-1	EINVAL	JRInvalidValue	The request was not successful. An invalid value was specified in the request/response header, or a filter was provided on the request.
-1	EMVSERR	JRUnexpectedErr	The request was not successful. An unexpected error occurred.

An application can use any of the following methods to invoke the EZBREIFR service:

Issue a LOAD macro to obtain the EZBREIFR service entry point address, and then issue a CALL macro specifying that address. The EZBREIFR load module must reside in a linklist dataset (for example, the SEZALOAD load library of TCP/IP), or in the LPA.
Issue a LINK macro to invoke the EZBREIFR service. The EZBREIFR load module must reside in a link list data set (for example, the SEZALOAD load library of TCP/IP), or in the link pack area (LPA).
Link-edit EZBREIFR directly into the application load module, and then issue a CALL macro specifying EZBREIFR. Include SYS1.CSSLIB(EZBREIFR) in the application load module link-editing.
For 64-bit C/C++ applications, link-edit the EZBREIF4 program directly into the application load module, and then issue a CALL macro specifying EZBREIFR. Include SYS1.CSSLIB(EZBREIF4) in the application load module link-editing.