MdmrControlFont

• See also
User Guide:
Fonts Steps to read dot-matrix strings from an image
Reference:
MdmrAlloc MdmrControl MdmrImportFont MdmrInquire MdmrInquireFont MdmrRead
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
dmreditfontfile.cpp
dmrgenfontfile.cpp

MdmrControl
MdmrControlStringModel

Description

Parameters

ContextDmrId

Specifies the identifier of the SureDotOCR context that contains the fonts to control. The context must have been previously allocated on the system using MdmrAlloc().

FontLabelOrIndex

Specifies the font (one or all) to control. Set this parameter to one of the values below:

For specifying the font
Value	Description
M_FONT_INDEX( MIL_INT IndexValue )	Specifies to control the font by indicating its index. (summarize) Specifies to control the font by indicating its index. (more details...)
		Parameters
		IndexValue Specifies the index of the font.
			0 <= Value < M_NUMBER_OF_FONTS Specifies the index of the font to control.
M_FONT_LABEL( MIL_INT LabelValue )	Specifies to control the font by indicating its label. (summarize) Specifies to control the font by indicating its label. (more details...)
		Parameters
		LabelValue Specifies the label of the font.
			0 < Value < 2097152 Specifies the label of the font to control.
M_ALL	Specifies to control all fonts.

CharIndex

Specifies the index of a character in the font, if required. Set this parameter to one of the values below:

For specifying the index of a character
Value	Description
M_DEFAULT	Specifies that the index of a character is not required.
M_ALL	Specifies all characters. Only specify this value for M_CHAR_DELETE. (summarize) Specifies all characters. (more details...)
Value >= 0	Specifies the index of a character.

CharNamePtr

Specifies the name of a character in the font, if required. Set this parameter to one of the values below:

For specifying the name of the character
Value	Description
M_NULL	Specifies that the name of the character is not required.
MIL_TEXT("CharName") 1	Specifies the name of the character. For example, 'A' would be the name that identifies the first uppercase letter of the English alphabet. When using the CharNamePtr parameter to specify the name of a character, the CharIndex parameter must be set to M_DEFAULT. When working in an ASCII environment, you can specify Unicode character names; these names must be in hexadecimal format and begin with "\x". This is required for specifying character names beyond the Basic Latin range. For example, Basic Latin does not include the smiley face character; to specify it, use "\x263A". When working in a Unicode environment, you can directly specify the smiley face as the name of the character. Character names must be unique among all character names in the font. Specifying the name of a character that already exists causes an error. To avoid unpredictable results, character names should match the dot-matrix that they represent. (summarize) Specifies the name of the character. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

ControlType

Specifies the type of control to set.

See the Parameter associations section for possible values that can be specified.

ControlValue

Specifies the required value for the control.

Set this parameter to M_DEFAULT if not used.

See the Parameter associations section for possible values that can be specified.

ControlValuePtr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

• array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ]
• M_NULL
• MIL_CONST_TEXT_PTR [optionally, in C++: a reference to a MIL_STRING]

Specifies the address which contains more information about the setting's new value.

Set this parameter to M_NULL if not used. If you use this parameter, the ControlValue parameter must be M_DEFAULT.

See the Parameter associations section for possible values that can be specified.

Parameter associations

The tables below list possible values for the ControlType, ControlValue, and ControlValuePtr parameters.

• For controlling a global setting of a font
• For controlling a font's characters

The following ControlType and corresponding ControlValue and ControlValuePtr parameter settings are used to control a global setting of a font. Unless otherwise specified, set the FontLabelOrIndex parameter to the label or index of a font (one or all), set the CharIndex parameter to M_DEFAULT, and set the CharNamePtr parameter to M_NULL.

For controlling a global setting of a font
ControlType			Description
	ControlValue
	ControlValuePtr
M_FONT_LABEL_VALUE			Modifies the label value of the font. Set the FontLabelOrIndex parameter to a specific font. Specifying all fonts causes an error. (summarize) Modifies the label value of the font. (more details...)
	ControlValue		Specifies the following. (summarize) Specifies the following. (more details...)
		0 < Value < 2097152	Specifies the font's new label value, as an integer. The label must be unique among all font labels in the context. (summarize) Specifies the font's new label value, as an integer. (more details...)
	ControlValuePtr		Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL
M_FONT_SIZE_COLUMNS			Sets the number of columns in the font's dot-matrix template. Only specify this value for an empty font (no characters). The dot-matrix template defines the grid within which to represent every character in the font. Fonts are typically added with MdmrImportFont(). In this case, the dimensions of the characters' dot-matrix in the font file (MDMRF) represent the dimensions of the dot-matrix template of the font. INQ (summarize) Sets the number of columns in the font's dot-matrix template. INQ (more details...)
	ControlValue		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_DEFAULT	Specifies the default value; the default value is 5 columns.
		Value > 0	Specifies the number of columns, as an integer.
	ControlValuePtr		Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL
M_FONT_SIZE_ROWS			Sets the number of rows in the font's dot-matrix template. Only specify this value for an empty font (no characters). The dot-matrix template defines the grid within which to represent every character in the font. Fonts are typically added with MdmrImportFont(). In this case, the dimensions of the characters' dot-matrix in the font file (MDMRF) represent the dimensions of the dot-matrix template of the font. INQ (summarize) Sets the number of rows in the font's dot-matrix template. INQ (more details...)
	ControlValue		Specifies one of the following. (summarize) Specifies one of the following. (more details...)
		M_DEFAULT	Specifies the default value; the default value is 7 rows.
		Value > 0	Specifies the number of rows, as an integer.
	ControlValuePtr		Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL

The following ControlType and corresponding ControlValue and ControlValuePtr parameter settings are used to control a font's characters. Unless otherwise specified, set the FontLabelOrIndex parameter to the label or index of a font (one or all), and set either the CharIndex parameter to a character index or the CharNamePtr parameter to the name of a character.

For controlling a font's characters
ControlType			Description
	ControlValue
	ControlValuePtr
M_CHAR_ADD			Adds a character to the font. To add multiple characters, call this function multiple times. SureDotOCR assigns an index to each character, starting with 0. Use the CharNamePtr parameter to specify the name of the character and set the CharIndex parameter to M_DEFAULT. Fonts should only contain characters you want to read. (summarize) Adds a character to the font. (more details...)
	ControlValue		Specifies the following. (summarize) Specifies the following. (more details...)
		M_DEFAULT	Implements the default behavior.
	ControlValuePtr		Data type info: Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] MORE Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] Required array size: MdmrInquireFont ( M_FONT_SIZE_COLUMNS ) * MdmrInquireFont ( M_FONT_SIZE_ROWS ) Specifies the address of an array containing the dot-matrix of the character to add to the font. You must define the dot-matrix in the array, one row contiguously after the other; use "FF" for dots that represent the character; otherwise use "00". The dot-matrix of the font's characters should be identical to the dot-matrix of the characters in the strings to read. You must organize the character data in the specified array according to the dimensions of the font's dot-matrix template. To inquire the dimensions, call MdmrInquireFont() with M_FONT_SIZE_COLUMNS and M_FONT_SIZE_ROWS. The dot-matrix of all characters in a font must have these dimensions. The dots that make up the dot-matrix are specific to each character. (summarize) Data type info: Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] MORE Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] Required array size: MdmrInquireFont ( M_FONT_SIZE_COLUMNS ) * MdmrInquireFont ( M_FONT_SIZE_ROWS ) Specifies the address of an array containing the dot-matrix of the character to add to the font. (more details...)
M_CHAR_DELETE			Deletes characters in a font. To delete a specific character in a font, set the CharIndex parameter to the index of the character to delete, or set the CharNamePtr parameter to the name of the character to delete. To delete all characters in a font, set the CharIndex parameter to M_ALL and the CharNamePtr parameter to M_NULL. (summarize) Deletes characters in a font. (more details...)
	ControlValue		Specifies the following. (summarize) Specifies the following. (more details...)
		M_DEFAULT	Implements the default behavior.
	ControlValuePtr		Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL Data type info: Data type: Set this parameter to M_NULL Data type: Set this parameter to M_NULL
M_CHAR_NAME			Renames a character in a font. (summarize) Renames a character in a font. (more details...)
	ControlValue		Specifies the following. (summarize) Specifies the following. (more details...)
		M_DEFAULT	Implements the default behavior.
	ControlValuePtr		Data type info: Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Note: When using C++, you can pass a reference to a MIL_STRING instead. Specifies the following. (summarize) Data type info: Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Note: When using C++, you can pass a reference to a MIL_STRING instead. Specifies the following. (more details...)
		MIL_TEXT("CharName") 1	Specifies the character's new name. To indicate the character to rename, use either the CharIndex parameter or the CharNamePtr parameter. Character names must be unique among all character names in the font. To avoid unpredictable results, character names should match the dot-matrix that represents them. (summarize) Specifies the character's new name. (more details...)
M_CHAR_TEMPLATE			Redefines the dot-matrix of a character in a font. INQ (summarize) Redefines the dot-matrix of a character in a font. INQ (more details...)
	ControlValue		Specifies the following. (summarize) Specifies the following. (more details...)
		M_DEFAULT	Implements the default behavior.
	ControlValuePtr		Data type info: Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] MORE Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] Required array size: MdmrInquireFont ( M_FONT_SIZE_COLUMNS ) * MdmrInquireFont ( M_FONT_SIZE_ROWS ) Specifies the address of an array containing the character's new dot matrix. This character data must adhere to the same specifications as M_CHAR_ADD. To indicate the character to redefine, use either the CharIndex parameter or the CharNamePtr parameter. (summarize) Data type info: Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] MORE Data type: array of type MIL_UINT8 [optionally, in C++: a reference to a constant std::vector<MIL_UINT8> ] Required array size: MdmrInquireFont ( M_FONT_SIZE_COLUMNS ) * MdmrInquireFont ( M_FONT_SIZE_ROWS ) Specifies the address of an array containing the character's new dot matrix. (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Type-specific versions of the function when using a C compiler under 64-bit

void MdmrControlFontInt64 (MIL_ID ContextDmrId, MIL_INT64 FontLabelOrIndex, MIL_INT64 CharIndex, MIL_CONST_TEXT_PTR CharNamePtr, MIL_INT64 ControlType, MIL_INT64 ControlValue, const void *ControlValuePtr) Details Parameters ContextDmrId See ContextDmrId of the main function for a description. FontLabelOrIndex See FontLabelOrIndex of the main function for a description. CharIndex See CharIndex of the main function for a description. CharNamePtr See CharNamePtr of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue See ControlValue of the main function for a description. ControlValuePtr See ControlValuePtr of the main function for a description.

void MdmrControlFontDouble (MIL_ID ContextDmrId, MIL_INT64 FontLabelOrIndex, MIL_INT64 CharIndex, MIL_CONST_TEXT_PTR CharNamePtr, MIL_INT64 ControlType, MIL_DOUBLE ControlValue, const void *ControlValuePtr) Details Parameters ContextDmrId See ContextDmrId of the main function for a description. FontLabelOrIndex See FontLabelOrIndex of the main function for a description. CharIndex See CharIndex of the main function for a description. CharNamePtr See CharNamePtr of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue See ControlValue of the main function for a description. ControlValuePtr See ControlValuePtr of the main function for a description.