MQDLTMP - Delete message property
The MQDLTMP call deletes a property from a message handle and is the inverse of the MQSETMP call.
Syntax
MQDLTMP (Hconn, Hmsg, DltPropOpts, Name, CompCode, Reason)
Parameters
- Hconn
- Type: MQHCONN - input
This handle represents the connection to the queue manager. The value must match the connection handle that was used to create the message handle specified in the
Hmsg
parameter.If the message handle was created using MQHC_UNASSOCIATED_HCONN then a valid connection must be established on the thread deleting the message handle otherwise the call fails with MQRC_CONNECTION_BROKEN.
- Hmsg
- Type: MQHMSG - input
This is the message handle containing the property to be deleted. The value was returned by a previous MQCRTMH call.
- DltPropOpts
- Type: MQDMPO - input
See the MQDMPO data type for details.
- Name
- Type: MQCHARV - input
The name of the property to delete. See Property names for further information about property names.
Wildcards are not allowed in the property name.
- CompCode
- Type: MQLONG - output
The completion code; it is one of the following:
- MQCC_OK
- Successful completion.
- MQCC_WARNING
- Warning (partial completion).
- MQCC_FAILED
- Call failed.
- Reason
- Type: MQLONG - output
If
CompCode
is MQCC_OK:- MQRC_NONE
- (0, X'000') No reason to report.
IfCompCode
is MQCC_WARNING:- MQRC_PROPERTY_NOT_AVAILABLE
- (2471, X'09A7') Property not available.
- MQRC_RFH_FORMAT_ERROR
- (2421, X'0975') An MQRFH2 folder containing properties could not be parsed.
IfCompCode
is MQCC_FAILED:- MQRC_ADAPTER_NOT_AVAILABLE
- (2204, X'089C') Adapter not available.
- MQRC_ADAPTER_SERV_LOAD_ERROR
- (2130, X'0852') Unable to load adapter service module.
- MQRC_ASID_MISMATCH
- (2157, X'086D') Primary and home ASIDs differ.
- MQRC_CALL_IN_PROGRESS
- (2219, X'08AB') MQI call entered before previous call completed.
- MQRC_CONNECTION_BROKEN
- (2009, X'07D9') Connection to queue manager lost.
- MQRC_DMPO_ERROR
- (2481, X'09B1') Delete message property options structure not valid.
- MQRC_HMSG_ERROR
- (2460, X'099C') Message handle not valid.
- MQRC_MSG_HANDLE_IN_USE
- (2499, X'09C3') Message handle already in use.
- MQRC_OPTIONS_ERROR
- (2046, X'07FE') Options not valid or not consistent.
- MQRC_PROPERTY_NAME_ERROR
- (2442, X'098A') Invalid property name.
- MQRC_SOURCE_CCSID_ERROR
- (2111, X'083F') Property name coded character set identifier not valid.
- MQRC_UNEXPECTED_ERROR
- (2195, X'0893') Unexpected error occurred.
For detailed information about these codes, see:- Messages and reason codes for IBM® MQ for z/OS®
- API completion and reason codes for other IBM MQ platforms
C invocation
MQDLTMP (Hconn, Hmsg, &DltPropOpts, &Name, &CompCode, &Reason)
MQHCONN Hconn; /* Connection handle */
MQHMSG Hmsg; /* Message handle */
MQDMPO DltPropOpts; /* Options that control the action of MQDLTMP */
MQCHARV Name; /* Property name */
MQLONG CompCode; /* Completion code */
MQLONG Reason; /* Reason code qualifying CompCode */
COBOL invocation
CALL 'MQDLTMP' USING HCONN, HMSG, DLTPROPOPTS, NAME, COMPCODE, REASON.
** Connection handle
01 HCONN PIC S9(9) BINARY.
** Message handle
01 HMSG PIC S9(18) BINARY.
** Options that control the action of MQDLTMP
01 DLTPROPOPTS.
COPY CMQDMPOV.
** Property name
01 NAME
COPY CMQCHRVV.
** Completion code
01 COMPCODE PIC S9(9) BINARY.
** Reason code qualifying COMPCODE
01 REASON PIC S9(9) BINARY.
PL/I invocation
call MQDLTMP (Hconn, Hmsg, DltPropOpts, Name, CompCode, Reason);
dcl Hconn fixed bin(31); /* Connection handle */
dcl Hmsg fixed bin(63); /* Message handle */
dcl DltPropOpts like MQDMPO; /* Options that control the action of MQDLTMP */
dcl Name like MQCHARV; /* Property name */
dcl CompCode fixed bin(31); /* Completion code */
dcl Reason fixed bin(31); /* Reason code qualifying CompCode */
High Level Assembler invocation
CALL MQDLTMP,(HCONN,HMSG,DLTPROPOPTS,NAME,COMPCODE,REASON)
HCONN DS F Connection handle
HMSG DS D Message handle
DLTPROPOPTS CMQDMPOA , Options that control the action of MQDLTMP
NAME CMQCHRVA , Property name
COMPCODE DS F Completion code
REASON DS F Reason code qualifying COMPCODE