Parameters for Unregister_For

The following section describes the parameters you specify when calling the Unregister_For_Allocates service.

Notify_type

Supplied parameter

Type: Structure
Length: 4-8 bytes

Specifies the type of processing and notification (synchronous or asynchronous) requested for this service. The possible types are:

None
No notification is requested. APPC/MVS processes this call synchronously, and returns control to the caller when processing is complete. APPC/MVS sets all returned parameters on return to the caller. To specify no notification, set this parameter to a four-byte structure that contains binary zeroes.
ECB
Programs can request asynchronous processing by specifying an ECB to be posted when processing completes. To specify an ECB, set this parameter to an eight-byte structure that contains a fullword binary one (X'00000001'), followed by the address of a fullword area to be used as the ECB. The ECB must reside in the caller's home address space.

When you specify an ECB, APPC/MVS returns control to the caller before processing is complete, with only the return code set. If APPC/MVS accepts the asynchronous request, it sets the return code to 0 to show that it is processing the service asynchronously. APPC/MVS fills in the other returned parameters during asynchronous processing, and posts the specified ECB when it has set all the returned parameters. The completion code field in the ECB contains the return code for the service. APPC/MVS places the reason code, if any, in the server's reason_code parameter.

Allocate_queue_token

Supplied parameter

Type: Character string
Length: 8 bytes

Specifies the allocate queue token that indicates the particular allocate queue that the caller is to stop serving. (The allocate queue token is returned as output from a successful call to the Register_For_Allocates service.)

To unregister the caller for all allocate queues for which it is registered, set this parameter to binary zeroes.

Reason_code

Returned parameter

Type: Integer
Length: 32 bits

Contains additional information about the result of the call when the return_code parameter contains a non-zero value other than decimal 64 (atbcts_appc_not_available).

Table 1 lists the valid reason codes.

Return_code

Returned parameter

Type: Integer
Length: 32 bits

Contains the result of the call. If the return_code parameter contains zero or decimal 64 (atbcts_appc_not_available), there is no reason code. For other return codes, check the reason_code parameter for additional information about the result of the call.

Table 1 lists the valid return and reason codes for the Unregister_For_Allocates service.

Table 1. Return and Reason Codes for Unregister_For_Allocates
Return Code (Decimal)	Reason Code (Decimal)	Symbolic Value
0		atbcts_ok
4		atbcts_warning
	36	atbcts_unreg_all_no_registers
8		atbcts_parameter_error
	17	atbcts_inval_alloc_queue_token
	18	atbcts_inval_notify_type
16		atbcts_request_unsuccessful
	8	atbcts_cannot_hold_locks
	20	atbcts_request_cancelled
32		atbcts_service_failure
	16	atbcts_appc_service_failure
64		atbcts_appc_not_available

For more detailed information about these return codes and reason codes, see Explanation of Return and Reason Codes.