MQCFBS - Byte string parameter

Use this page to view the structure of an MQCFBS parameter and the declarations for the following programming languages: C, COBOL, PL/I, RPG/ILE, and S/390 assembler

The MQCFBS structure describes a byte string parameter. Following the links to the declarations is a description of the fields making up the MQCFBS structure:

C language
COBOL language
PL/I language ( z/OS® only)
RPG/ILE language ( IBM® i only)
S/390 assembler-language ( z/OS only)

Type

Description:

This indicates that the structure is an MQCFBS structure describing a byte string parameter.

Data type:

MQLONG.

Value:

MQCFT_BYTE_STRING: Structure defining a byte string.

StrucLength

Description: This is the length in bytes of the MQCFBS structure, including the variable-length string at the end of the structure (the String field).

Data type: MQLONG.

Parameter

Description:

This identifies the parameter with a value that is contained in the structure.

Data type:

MQLONG.

StringLength

Description: This is the length in bytes of the data in the String field, and is zero or greater.

Data type: MQLONG.

String

Description:

This is the value of the parameter identified by the Parameter field. The string is a byte string, and so is not subject to character-set conversion when sent between different systems.

Note: A null byte in the string is treated as normal data, and does not act as a delimiter for the string.

Data type: MQBYTE x StringLength.

C language declaration



struct tagMQCFBS {
  MQLONG  Type;          /* Structure type */
  MQLONG  StrucLength;   /* Structure length */
  MQLONG  Parameter;     /* Parameter identifier */
  MQLONG  StringLength;  /* Length of string */
  MQBYTE  String[1];     /* String value -- first character */
 } MQCFBS;

COBOL language declaration

**   MQCFBS structure
  10 MQCFBS.
**    Structure type
   15 MQCFBS-TYPE         PIC S9(9) BINARY.
**    Structure length
   15 MQCFBS-STRUCLENGTH  PIC S9(9) BINARY.
**    Parameter identifier
   15 MQCFBS-PARAMETER    PIC S9(9) BINARY.
**    Length of string
   15 MQCFBS-STRINGLENGTH PIC S9(9) BINARY.

PL/I language declaration ( z/OS only)

dcl
 1 MQCFBS based,
  3 Type         fixed bin(31), /* Structure type */
  3 StrucLength  fixed bin(31), /* Structure length */
  3 Parameter    fixed bin(31), /* Parameter identifier */
  3 StringLength fixed bin(31); /* Length of string */

RPG/ILE language declaration ( IBM i only)

     D*..1....:....2....:....3....:....4....:....5....:....6....:....7..
     D* MQCFBS Structure
     D*
     D* Structure type 
     D  BSTYP                  1      4I 0 INZ(9)
     D* Structure length 
     D  BSLEN                  5      8I 0 INZ(16)
     D* Parameter identifier 
     D  BSPRM                  9     12I 0 INZ(0)
     D* Length of string 
     D  BSSTL                 13     16I 0 INZ(0)
     D* String value -- first byte 
     D  BSSRA                 17     17    INZ

S/390 assembler-language declaration ( z/OS only)

MQCFBS               DSECT
MQCFBS_TYPE          DS   F  Structure type
MQCFBS_STRUCLENGTH   DS   F  Structure length
MQCFBS_PARAMETER     DS   F  Parameter identifier
MQCFBS_STRINGLENGTH  DS   F  Length of string
*
MQCFBS_LENGTH        EQU  *-MQCFBS
                     ORG  MQCFBS
MQCFBS_AREA          DS   CL(MQCFBS_LENGTH)