MstrSetConstraint

• See also
User Guide:
Rules for character placement Steps to reading a string in an image
Reference:
MstrAlloc MstrControl MstrInquire
Availability
Not available in MIL-Lite
Available in MIL


Available on Windows
Available on Linux


Not supported on:
Not supported on Matrox Indio (Update 53 or Update 68) (w)
Not supported on Matrox Concord PoE with ToE (Update 82) (z)
Fully supported on:
Fully supported on Host system (a)
Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)
Fully supported on Matrox Morphis (g)
Fully supported on Matrox Morphis QxT (h)
Fully supported on Matrox Orion HD (i)
Fully supported on Matrox Radient eCL (j)
Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)
Fully supported on Matrox Solios eA/XA (l)
Fully supported on Matrox Solios ecl/xcl/ev-cl (m)
Fully supported on Matrox USB3 Vision driver (Update 19) (o)
Fully supported on Matrox RadientPro-CL (Update 7) (p)
Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)
Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)
Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)
Fully supported on Matrox GenTL driver (Update 34) (v)
Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)
Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)


* Refer to the MIL system-specific information
   in the MIL Reference for the minimum update required.


For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note


Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP/GPm
Available on Matrox Supersight
Function map
Examples
mstr.cpp
mstr.cs
mstr.vb

MstrSave
MstrStream

Description

Parameters

ContextId

Specifies the String Reader context with which to associate the constraint. The String Reader context must have been previously allocated on the required system using MstrAlloc().

StringIndex

Specifies the string(s) in the String Reader context to affect.

Note that a new string can be added to the String Reader context using MstrControl() with M_STRING_ADD.

This parameter should be set to the following value:

For specifying the string index
Value	Description
M_STRING_INDEX( MIL_INT StringIndex )	Specifies that the constraint will be applied to a string or to all strings. (summarize) Specifies that the constraint will be applied to a string or to all strings. (more details...)
		Parameters
		StringIndex This parameter specifies the index of the string. You can set this parameter to one of the following:
			M_ALL Specifies that the constraint will be applied to all strings.
			0 <= Value < M_NUMBER_OF_STRING_MODELS Specifies the index of the individual string to which the constraint will be applied.

CharPos

Specifies the character position in the string for which to set the constraint.

A constraint can be set for any position, even a position greater than the maximum number of characters in the string. Constraints set at a position greater than the minimum number of characters in the string are ignored (when the string read does not contain a character at that position).

This parameter should be set to one of the following values:

For specifying the character position
Value	Description
M_DEFAULT	Sets the default constraint of the string model. The default constraint of the string model is used when no specific constraint is set to a given position. (summarize) Sets the default constraint of the string model. (more details...)
0 <= Value <= 255	Sets the character position in the string to which to apply the constraint.

ConstraintType INQ

Specifies the type of constraint to set.

By default, all constraints apply to any font in the context. For example, M_LETTER + M_DIGIT means any letter and any digit of any font is acceptable. To restrict the constraint to a specific font, see the combination value below.

For specifying the constraint
Value	Description
M_DEFAULT	Sets the constraint to the default constraint. For a specific character position (the CharPos parameter is set to an individual value), the default is the same as the default constraint of the string model. For the default character position (the CharPos parameter is set to M_DEFAULT), the default is the same as M_ANY. (summarize) Sets the constraint to the default constraint. (more details...)
M_ANY +	Sets the constraint to any character.
M_DIGIT +	Sets the constraint to any digit (0 to 9).
M_DIGIT + M_LETTER +	Sets the constraint to any digit (0 to 9) and any letter (a to z and A to Z).
M_LETTER +	Sets the constraint to any letter (a to z and A to Z). Note that M_LETTER does not differentiate between upper and lower cases. (summarize) Sets the constraint to any letter (a to z and A to Z). (more details...)

Combination values for M_DIGIT + M_LETTER; M_LETTER.

You can add one of the following values to the above-mentioned values to set the letter case of the constraint.

For specifying the letter case of the constraint
Combination value	Description
M_LOWERCASE	Sets the constraint to any lowercase letter (a to z).
M_UPPERCASE	Sets the constraint to any uppercase letter (A to Z).

Combination value for the values listed in For specifying the constraint.

You can add the following value to the above-mentioned values to set the constraint to a specific font.

For restricting the constraint
Combination value	Description
M_FONT_INDEX( MIL_INT FontIndex )	Specifies that the constraint will be restricted to a specific font. Note that this value is only available for a font-based context. (summarize) Specifies that the constraint will be restricted to a specific font. (more details...)
		Parameters
		FontIndex INQ This parameter specifies the index of the font. You can set this parameter to one of the following:
			0 <= Value < M_NUMBER_OF_FONTS Specifies the index of the individual font from which the constraint is taken. When setting the constraint, the font index can be the index of a font that does not currently exist. However, if the font still does not exist at preprocessing time, an error will be logged.

CharListPtr INQ

Specifies an explicit list of valid characters, at the specified position. This is an optional, null-terminated string.

All the specified characters must be compatible with the ConstraintType parameter definition. Each character in the character list must be unique; no character repetition is allowed in the CharListPtr parameter.

The string array must be of the right type for the encoding scheme selected (MstrInquire() with M_ENCODING).

Set this parameter to M_NULL if you are not specifying an explicit list.