MQCFSL - String list parameter

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

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

COBOL language
PL/I language ( z/OS® only)
RPG/ILE language ( IBM® i only)
System/390 assembler-language ( z/OS only)
Visual Basic language ( Windows only)

Type

Description:

This indicates that the structure is an MQCFSL structure describing a string-list parameter.

Data type:

MQLONG.

Value:

MQCFT_STRING_LIST: Structure defining a string list.

StrucLength

Description: This is the length in bytes of the MQCFSL structure, including the array of strings at the end of the structure (the Strings field).

Data type: MQLONG.

Parameter

Description:

This identifies the parameter with values that are contained in the structure.

Data type:

MQLONG.

CodedCharSetId

Description: This specifies the coded character set identifier of the data in the Strings field.

Data type: MQLONG.

Count

Description: This is the number of strings present in the Strings field; zero or greater.

Data type: MQLONG.

StringLength

Description: This is the length in bytes of one parameter value, that is the length of one string in the Strings field; all of the strings are this length.

Data type: MQLONG.

String

Description:

This is a set of string values for the parameter identified by the Parameter field. The number of strings is given by the Count field, and the length of each string is given by the StringLength field. The strings are concatenated together, with no bytes skipped between adjacent strings. The total length of the strings is the length of one string multiplied by the number of strings present (that is, StringLength x Count).

In MQFMT_EVENT messages, trailing blanks can be omitted from string parameters (that is, the string may be shorter than the defined length of the parameter). StringLength gives the length of the string actually present in the message.

Note: In the MQCFSL structure, a null character in a string is treated as normal data, and does not act as a delimiter for the string. This means that when a receiving application reads a MQFMT_EVENT message, the receiving application receives all of the data specified by the sending application. The data may, of course, have been converted between character sets (for example, by the receiving application specifying the MQGMO_CONVERT option on the MQGET call).

Data type: MQCHAR x StringLength x Count

COBOL language declaration

**   MQCFSL structure
  10 MQCFSL.
**    Structure type
   15 MQCFSL-TYPE           PIC S9(9) BINARY.
**    Structure length
   15 MQCFSL-STRUCLENGTH    PIC S9(9) BINARY.
**    Parameter identifier
   15 MQCFSL-PARAMETER      PIC S9(9) BINARY.
**    Coded character set identifier
   15 MQCFSL-CODEDCHARSETID PIC S9(9) BINARY.
**    Count of parameter values
   15 MQCFSL-COUNT          PIC S9(9) BINARY.
**    Length of one string
   15 MQCFSL-STRINGLENGTH   PIC S9(9) BINARY.

PL/I language declaration

dcl
 1 MQCFSL based,
  3 Type           fixed bin(31), /* Structure type */
  3 StrucLength    fixed bin(31), /* Structure length */
  3 Parameter      fixed bin(31), /* Parameter identifier */
  3 CodedCharSetId fixed bin(31), /* Coded character set identifier */
  3 Count          fixed bin(31), /* Count of parameter values */
  3 StringLength   fixed bin(31); /* Length of one string */

RPG/ILE declaration ( IBM i only)

     D*..1....:....2....:....3....:....4....:....5....:....6....:....7..
     D* MQCFSL Structure
     D*
     D* Structure type
     D  SLTYP                  1      4I 0
     D* Structure length
     D  SLLEN                  5      8I 0
     D* Parameter identifier
     D  SLPRM                  9     12I 0
     D* Coded character set identifier
     D  SLCSI                 13     16I 0
     D* Count of parameter values
     D  SLCNT                 17     20I 0
     D* Length of one string
     D  SLSTL                 21     24I 0

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

MQCFSL                 DSECT
MQCFSL_TYPE            DS   F  Structure type
MQCFSL_STRUCLENGTH     DS   F  Structure length
MQCFSL_PARAMETER       DS   F  Parameter identifier
MQCFSL_CODEDCHARSETID  DS   F  Coded character set identifier
MQCFSL_COUNT           DS   F  Count of parameter values
MQCFSL_STRINGLENGTH    DS   F  Length of one string
*
MQCFSL_LENGTH          EQU  *-MQCFSL
                       ORG  MQCFSL
MQCFSL_AREA            DS   CL(MQCFSL_LENGTH)

Visual Basic language declaration ( Windows systems only)

Type MQCFSL
  Type           As Long 'Structure type'
  StrucLength    As Long 'Structure length'
  Parameter      As Long 'Parameter identifier'
  CodedCharSetId As Long 'Coded character set identifier'
  Count          As Long 'Count of parameter values'
  StringLength   As Long 'Length of one string'
End Type