MQMHBO (Message handle to buffer options) on IBM i

Structure defining the message handle to buffer options

Overview

Purpose: The MQMHBO structure allows applications to specify options that control how buffers are produced from message handles. The structure is an input parameter on the MQMHBUF call.

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

• Fields
• Initial values
• RPG declaration

Fields

The MQMHBO structure contains the following fields; the fields are described in alphabetical order:

MBOPT (10-digit signed integer)

Message handle to buffer options structure - MBOPT field.

These options control the action of MQMHBUF.

You must specify the following option:

MBPRRF

When converting properties from a message handle into a buffer, convert them into the MQRFH2 format.

Optionally, we can also specify the following option. To specify more than one option, either add the values together (do not add the same constant more than once), or combine the values using the bitwise OR operation (if the programming language supports bit operations).

MBDLPR

Properties that are added to the buffer are deleted from the message handle. If the call fails no properties are deleted.

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

MBSID (10-digit signed integer)

Message handle to buffer options structure - MBSID field.

This is the structure identifier. The value must be:

MBSIDV

Identifier for message handle to buffer options structure.

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

MBVER (10-digit signed integer)

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

MBVER1

Version number for message handle to buffer options structure.

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

MBVERC

Current version of message handle to buffer options structure.

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

Initial values

1. The value Null string or blanks denotes a blank character.

RPG declaration

     D* MQMHBO Structure
     D*
     D*
     D* Structure identifier
     D  MBSID                  1      4    INZ('MHBO')
     D*
     D* Structure version number
     D  MBVER                  5      8I 0 INZ(1)
     D*
     D* Options that control the action of MQMHBUF
     D  MBOPT                  9     12I 0 INZ(1)