MQDMPO (Delete message property options) on IBM i

Structure defining the delete message property options.

Overview

Purpose: The MQDMPO structure allows applications to specify options that control how properties of messages are deleted. The structure is an input parameter on the MQDLTMP call.

Character set and encoding: Data in MQDMPO must be in the character set of the application and encoding of the application (ENNAT).

Fields
Initial values
RPG declaration

Fields

The MQDMPO structure contains the following fields; the fields are described in alphabetic order:

DPOPT (10-digit signed integer)

Delete message property options structure - DPOPT field.

Location options: The following options relate to the relative location of the property compared to the property cursor.

DPDELF

Deletes the first property that matches the specified name.

DPDELC

Deletes the property pointed to by the property cursor; that is the property that was last inquired by using either the IPINQF or the IPINQN option.

The property cursor is reset when the message handle is reused. It is also reset when the message handle is specified in the HMSG field of the MQGMO on an MQGET call, or MQPMO structure on an MQPUT call.

The property cursor is reset when the message handle is reused, or when the message handle is specified in the HMSG field of the MQGMO structure on an MQGET structure on an MQGET call or MQPMO structure on an MQPUT call.

The call fails with completion code CCFAIL and reason RC2471 if this option is used when the property cursor has not yet been established. It also fails with these codes if the property pointed to by the property cursor has already been deleted..

If neither of these options is required, the following option can be used:

DPNONE: No options specified.

The initial value of this input field is DPDELF.

DPSID (10-digit signed integer)

Delete message property options structure - DPSID field.

This is the structure identifier. The value must be:

DPSIDV: Identifier for delete message property options structure.

This field is always an input field. The initial value of this field is DPSIDV.

DPVER (10-digit signed integer)

Delete message property options structure - DPVER field.

This is the structure version number. The value must be:

DPVER1: Version number for delete message property options structure.

The following constant specifies the version number of the current version:

DPVERC: Current version of delete message property options structure.

This field is always an input field. The initial value of this field is DPVER1.

Initial values

Table 1. Initial values of fields in MQDPMO
Field name	Name of constant	Value of constant
DPSID	DPSIDV	'DMPO'
DPVER	DPVER1	1
DPOPT	Options that control the action of MQDLTMP	DPNONE

RPG declaration

     D* MQDMPO Structure
     D*
     D*
     D* Structure identifier
     D  DPSID                  1      4    INZ('DMPO')
     D*
     D* Structure version number
     D  DPVER                  5      8I 0 INZ(1)
     D*
     ** Options that control the action of
     D* MQDLTMP
     D  DPOPT                  9     12I 0 INZ(0)