Optional parameters

QueueManagerName
name:
"MQPSQMgrName"   (string constant: MQPS_Q_MGR_NAME)
value:
The subscriber's queue manager name.

If QueueManagerName is not present, it defaults to the ReplyToQMgr name in the message descriptor (MQMD). If the resulting name is blank, it matches a subscriber that registered with a blank queue manager name.

QueueName
name:
"MQPSQName"   (string constant: MQPS_Q_NAME)
value:
The subscriber's queue name.

If QueueName is not present, it defaults to the ReplyToQ name in the message descriptor (MQMD), which must not be blank in this case.

RegistrationOptions
name:
"MQPSRegOpts"   (string constant: MQPS_REGISTRATION_OPTIONS)
value:
The following registration options can be specified:

"CorrelAsId"  
(string constant: MQPS_CORREL_ID_AS_IDENTITY, integer constant: MQREGO_CORREL_ID_AS_IDENTITY).

The CorrelId in the MQMD (which must not be zero) is part of the subscriber's identity.

"DeregAll"  
(string constant: MQPS_DEREGISTER_ALL, integer constant: MQREGO_DEREGISTER_ALL).

All topics registered for this subscriber are to be deregistered. If this option is set, the Topic parameter must be omitted.

"FullResp"  
(string constant: MQPS_FULL_RESPONSE, integer constant: MQREGO_FULL_RESPONSE).

When FullResp is specified, all the attributes of the subscription are returned in the response message if the command does not fail. See details under Register Subscriber. When FullResp is specified, DeregAll is not permitted in the Deregister Subscriber command or multiple topics.

"LeaveOnly"  
(string constant: MQPS_LEAVE_ONLY, integer constant: MQREGO_LEAVE_ONLY).

When LeaveOnly is specified with a SubIdentity that is in the identity set for the subscription, the SubIdentity is removed from the identity set for the subscription, but the subscription is not removed from the broker, even if the resulting identity set is empty.

If the SubIdentity value is not in the identity set the command fails.

LeaveOnly must be specified with a SubIdentity.

If neither LeaveOnly nor SubIdentity are specified, the subscription is removed regardless of the contents of the identity set for the subscription.

"VariableUserId"  
(string constant: MQPS_VARIABLE_USER_ID, integer constant: MQREGO_VARIABLE_USER_ID).

If the subscription to be deregistered has VariableUserId set this must be set when the Deregister Subscriber command is sent to indicate which subscription is being deregistered. Otherwise, the userid of the Deregister Subscriber command will be used to identify the subscription. This is overridden (along with the other subscriber identifiers) if a subscription name is supplied.

The default if this tag is omitted is that no options are set. In this case, the Topic parameter is required.

StreamName
name:
"MQPSStreamName"   (string constant: MQPS_STREAM_NAME)
value:
The name of the publication stream for the specified Topic(s).

The default value is SYSTEM.BROKER.DEFAULT.STREAM.

SubIdentity
name:
"MQPSSubIdentity"   (string constant: MQPS_SUBSCRIPTION_IDENTITY)
value:
Subscription identity.

See Register Subscriber for more details. If the SubIdentity is in the identity set for the subscription, it is removed from the set.

If the identity set becomes empty as a result of this, the subscription is removed from the broker (unless LeaveOnly is specified).

If the identity set still contains other identities, the subscription is not removed from the broker and publication flow is not interrupted.

SubName
name:
"MQPSSubName"   (string constant: MQPS_SUBSCRIPTION_NAME)
value:
Subscription name.

The SubName value takes precedence over all other identifier fields except the userid unless VariableUserId is set on the subscription itself.

If VariableUserId is not set, the Deregister Subscriber command succeeds only if the userid of the command message matches that of the subscription.

If a subscription exists that matches the traditional identity of this command but has no SubName, the Deregister Subscriber command fails.

If an attempt is made to deregister a subscription that has a SubName using a command message that matches the traditional identity but with no SubName specified, the command succeeds.

Topic
name:
"MQPSTopic"   (string constant: MQPS_TOPIC)
value:
The topic being deregistered. Wild cards are allowed, but a specified topic string must match exactly the corresponding string that was originally specified in the Register Subscriber command.

If DeregAll is specified in RegistrationOptions, the Topic parameter must be omitted. Otherwise, it is required, and can optionally be repeated for as many topics as needed. Topics specified can be a subset of those for which the subscriber is registered if it wants to retain subscriptions to the other topics.