Home

 

Fields

 

Type (MQLONG)

Structure type.

This indicates that the structure is an MQCFBS structure describing byte string parameter. The value must be:

MQCFT_BYTE_STRING

Structure defining a byte string.

StrucLength (MQLONG)

Structure length.

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.

The following constant gives the length of the fixed part of the structure, that is the length excluding the String field:

MQCFBS_STRUC_LENGTH_FIXED

Length of fixed part of MQCFBS structure.

Parameter (MQLONG)

Parameter identifier.

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; see MQCFH - PCF header for details. In user PCF messages (MQCFT_USER), this field has no significance.

The parameter is from the MQBACF_* group of parameters.

StringLength (MQLONG)

Length of string.

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.

String (MQBYTE×StringLength)

String value.

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.

A null character in the string is treated as normal data, and does not act as a delimiter for the string

For MQFMT_ADMIN messages, if the specified string is shorter than the standard length of the parameter, the omitted characters are assumed to be nulls. If the specified string is longer than the standard length, it is an error.

The way that this field is declared depends on the programming language:

• For the C programming language, the field is declared as an array with one element. Storage for the structure must be allocated dynamically, and pointers used to address the fields within it.

• For other programming languages, the field is omitted from the structure declaration. When an instance of the structure is declared, include MQCFBS in a larger structure, and declare additional fields following MQCFBS, to represent the String field as required.

 

Parent topic:

MQCFBS - PCF byte string parameter

pc14790_

 

Home