Fields

Type (MQLONG)
Structure type.

This indicates that the structure is a MQCFSF structure describing a string filter parameter. The value must be:

MQCFT_STRING_FILTER
Structure defining a string filter.
StrucLength (MQLONG)
Structure length.

This is the length in bytes of the MQCFSF structure. The value must be:

MQCFSF_STRUC_LENGTH
This is the length, in bytes, of the MQCFSF structure, including the string at the end of the structure (the FilterValue field). The length must be a multiple of 4, and must be sufficient to contain the string. 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 FilterValue field:

MQCFSF_STRUC_LENGTH_FIXED
Length of fixed part of command format filter string-parameter structure.
Parameter (MQLONG)
Parameter identifier.

This identifies the parameter that is to be filtered on. The value of this identifier depends on the parameter to be filtered on. Any of the parameters which can be used in the Inquire command can be used in this field.

The parameter is from the following groups of parameters:

Operator (MQLONG)
Operator identifier.

This identifies the operator that is being used to evaluate whether the parameter satisfies the filter-value.

Possible values are:

MQCFOP_GREATER
Greater than
MQCFOP_LESS
Less than
MQCFOP_EQUAL
Equal to
MQCFOP_NOT_EQUAL
Not equal to
MQCFOP_NOT_LESS
Greater than or equal to
MQCFOP_NOT_GREATER
Less than or equal to
MQCFOP_LIKE
Matches a generic string
MQCFOP_NOT_LIKE
Does not match a generic string
MQCFOP_CONTAINS
Contains a specified string. Use this when filtering on lists of strings.
MQCFOP_EXCLUDES
Does not contain a specified string. Use this when filtering on lists of strings.
MQCFOP_CONTAINS_GEN
Contains an item which matches a generic string. Use this when filtering on lists of strings.
MQCFOP_EXCLUDES_GEN
Does not contain any item which matches a generic string. Use this when filtering on lists of strings.

See the FilterValue description for details telling you which operators may be used in which circumstances.

CodedCharSetId (MQLONG)
Coded character set identifier.

This specifies the coded character set identifier of the data in the FilterValue field. The following special value can be used:

MQCCSI_DEFAULT
Default character set identifier.

The string data is in the character set defined by the CodedCharSetId field in the MQ header structure that precedes the MQCFH structure, or by the CodedCharSetId field in the MQMD if the MQCFH structure is at the start of the message.

FilterValueLength (MQLONG)
Length of filter-value string.

This is the length, in bytes, of the data in the FilterValue field. This must be zero or greater, and does not need to be a multiple of 4.

FilterValue (MQCHAR×FilterValueLength)
Filter value.

This specifies the filter-value that must be satisfied. Depending on the parameter, the value and the permitted operators can be:

Notes:
  1. If the specified string is shorter than the standard length of the parameter in MQFMT_ADMIN command messages, the omitted characters are assumed to be blanks. If the specified string is longer than the standard length, it is an error.
  2. When the queue manager reads an MQCFSF structure in an MQFMT_ADMIN message from the command input queue, the queue manager processes the string as though it had been specified on an MQI call. This means that within the string, the first null and the characters following it (up to the end of the string) are treated as blanks.

The filter value must be a valid value for the parameter being tested.