Event Monitoring: MQCFBS - Byte string parameter

MQCFBS - Byte string parameter

The MQCFBS structure describes an byte string parameter in an event message.

Type

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

Datatype: MQLONG.

Initial value: MQCFT_BYTE_STRING.

Valid 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). The length must be a multiple of four, and must be sufficient to contain the string; any bytes between the end of the string and the length defined by the StrucLength field are not significant.

Datatype: MQLONG.

Initial value: MQCFBS_STRUC_LENGTH_FIXED.

Valid value:

MQCFBS_STRUC_LENGTH_FIXED

Length of fixed part of the MQCFBS structure, that is the length excluding the String field.

Parameter

Description: This identifies the parameter whose value is contained in the structure. The values that can occur in this field depend on the value of the Command field in the MQCFH structure.

Datatype: MQLONG.

Initial value: 0.

StringLength

Description: This is the length in bytes of the data in the String field; it must be zero or greater. This length need not be a multiple of four.

Datatype: MQLONG.

Initial value: 0.

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.

Datatype: MQBYTE ×StringLength.

Initial value: Null string. (Only present in C)

C language declaration (MQCFBS)
typedef struct tagMQCFBS MQCFBS;
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 */
};
COBOL language declaration (MQCFBS)
**   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 (MQCFBS) (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 */
System/390 assembler-language declaration (MQCFBS) (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)

Description:	This indicates that the structure is an MQCFBS structure describing a byte string parameter.
Datatype:	MQLONG.
Initial value:	MQCFT_BYTE_STRING.
Valid value:	MQCFT_BYTE_STRING Structure defining a byte string.

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). The length must be a multiple of four, and must be sufficient to contain the string; any bytes between the end of the string and the length defined by the StrucLength field are not significant.
Datatype:	MQLONG.
Initial value:	MQCFBS_STRUC_LENGTH_FIXED.
Valid value:	MQCFBS_STRUC_LENGTH_FIXED Length of fixed part of the MQCFBS structure, that is the length excluding the String field.

Description:	This identifies the parameter whose value is contained in the structure. The values that can occur in this field depend on the value of the Command field in the MQCFH structure.
Datatype:	MQLONG.
Initial value:	0.

Description:	This is the length in bytes of the data in the String field; it must be zero or greater. This length need not be a multiple of four.
Datatype:	MQLONG.
Initial value:	0.

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.
Datatype:	MQBYTE ×StringLength.
Initial value:	Null string. (Only present in C)