MIL_ID ContextDmrId, | //in |
MIL_INT64 StringModelLabelOrIndex, | //in |
MIL_INT64 Position, | //in |
MIL_INT64 ControlType, | //in |
MIL_DOUBLE ControlValue1, | //in |
MIL_DOUBLE ControlValue2, | //in |
const void *ControlValuePtr | //in |
This function allows you to control a global setting of a SureDotOCR string model, or to control a position in a string model. This includes setting constraints for the different positions. Constraints restrict the characters permitted to be read, according to a character type and font. String models, along with their constraints, represent the dot-matrix strings to read from a target image. Initially, any character from any font can be read at every string model position.
String models are held in a SureDotOCR context. To add string models to a context, use MdmrControl(). To inquire about string models, use MdmrInquireStringModel().
You can set default constraints for all the positions in the string model, and override the constraints for specific positions. If you override the constraints for a specific position, the position is said to be explicitly constrained; otherwise, it is said to be implicitly constrained. To set the default constraints for the positions in the string model, call this function and pass M_DEFAULT to the Position parameter; to set explicit constraints for a position, pass M_POSITION_IN_STRING(n) instead, where n is the position to constrain.
If you previously constrained a position, you can further constrain it by specifying its exact position in the string model, or by indicating the order in which it was originally constrained. For example, if you explicitly constrained positions 14 and 22, you can further constrain position 22 using either M_POSITION_IN_STRING(n), where n is 22, or M_POSITION_CONSTRAINED_ORDER(n), where n is 1.
Once you have explicitly constrained a position, it is considered to be explicitly constrained until you call this function with M_RESET_POSITION_TO_IMPLICIT_CONSTRAINTS for that position, even if you have manually set the position's constraints back to the defaults of the string model. Note that the constrained order of a position changes if you reset previously constrained positions to be implicitly constrained (M_RESET_POSITION_TO_IMPLICIT_CONSTRAINTS).
For a successful read operation, you must specify an explicit value for the global string model controls that set the maximum and minimum number of characters in the string (M_STRING_SIZE_MIN and M_STRING_SIZE_MAX, or M_STRING_SIZE_MIN_MAX).
You must preprocess the SureDotOCR context after you have finished modifying its string models and before calling MdmrRead(). To know if a context needs to be preprocessed, call MdmrInquire() with M_PREPROCESSED.
Specifies the identifier of the SureDotOCR context that contains the string model to control. The context must have been previously allocated on the system using MdmrAlloc().
Specifies the string model (one or all) to control. Set this parameter to one of the values below:
For specifying the string model
|
|||||||||||||||||||||||||||||||||||||||
Value | Description | ||||||||||||||||||||||||||||||||||||||
Specifies to control the string model by indicating its index. (summarize)Specifies to control the string model by indicating its index. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index of the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
Specifies to control the string model by indicating its label. (summarize)Specifies to control the string model by indicating its label. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label of the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
M_ALL |
Specifies to control all string models. |
Specifies how to control the string model. Set this parameter to one of the values below:
For specifying how to control to the string
model
|
|||||||||||||||||||||||||||||||||||||||
Value | Description | ||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies to control a global setting of a string model. |
||||||||||||||||||||||||||||||||||||||
Specifies to control an explicitly constrained position in the string model by indicating the order in which the position was explicitly constrained. (summarize)Specifies to control an explicitly constrained position in the string model by indicating the order in which the position was explicitly constrained. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the order in which the position was explicitly constrained. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
Specifies to control a position in the string model. (summarize)Specifies to control a position in the string model. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the position in the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
M_ALL_CONSTRAINED_POSITIONS |
Specifies to control all explicitly constrained positions in the string model. |
Specifies the type of control to set.
See the Parameter associations section for possible values that can be specified.
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.
Specifies the second 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.
Specifies the address which contains more information about the setting's new value.
Set this parameter to M_NULL if not used.
See the Parameter associations section for possible values that can be specified.
The tables below list possible values for the ControlType, ControlValue1, ControlValue2, and ControlValuePtr parameters.
The following ControlType and corresponding ControlValue1, ControlValue2, and ControlValuePtr parameter settings are used to control a global setting of a string model. In this case, set the StringModelLabelOrIndex parameter to the label or index of a string model (one or all, unless otherwise specified), and set the Position parameter to M_DEFAULT.
For controlling a global setting of a string
model
|
|||||||||||||||||||||||||||||||||||||||
|
Description | ||||||||||||||||||||||||||||||||||||||
ControlValue1 | |||||||||||||||||||||||||||||||||||||||
ControlValue2 | |||||||||||||||||||||||||||||||||||||||
ControlValuePtr | |||||||||||||||||||||||||||||||||||||||
M_CHAR_ACCEPTANCE |
Sets the acceptance level for the score of the string's characters. This score quantifies the similarity between the characters in the target string and the corresponding characters in the font that the string model uses. For the string to be read, the score of every character must be greater than or equal to the specified character acceptance. To retrieve character scores, call MdmrGetResult() with M_CHAR_SCORE. INQ (summarize)Sets the acceptance level for the score of the string's characters. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies one of the following. (summarize)Specifies one of the following. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 50.0%. |
||||||||||||||||||||||||||||||||||||||
0.0 <= Value <= 100.0 |
Specifies the acceptance level for the character score, as a percentage. 100.0% indicates that the character in the target string perfectly resembles the corresponding character in the font (perfection is generally hard to obtain). (summarize)Specifies the acceptance level for the character score, as a percentage. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_ACCEPTANCE |
Sets the acceptance level for the string's score. This score quantifies the similarity between the target string and the string model. For the string to be read, its score must be greater than or equal to the specified acceptance. The string's score is the average score of all its characters. Even if the string's score is above the string's acceptance, the string might not be read if one or more if its characters is below the character's acceptance (M_CHAR_ACCEPTANCE). In this case, consider lowering the character's acceptance. To retrieve the score of the string or its characters, call MdmrGetResult() with M_STRING_SCORE or M_CHAR_SCORE. INQ (summarize)Sets the acceptance level for the string's score. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies one of the following. (summarize)Specifies one of the following. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 50.0%. |
||||||||||||||||||||||||||||||||||||||
0.0 <= Value <= 100.0 |
Specifies the acceptance level for the string's score, as a percentage. 100.0% indicates that the string in the target image perfectly resembles the string model (perfection is generally hard to obtain). (summarize)Specifies the acceptance level for the string's score, as a percentage. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_CERTAINTY |
Sets the certainty level for the string's score. This score quantifies the similarity between the target string and the string model. If the string's score is equal to or above the certainty, the string is immediately read as a valid string result, without processing the rest of the target image for strings with higher scores (provided the specified number of strings to read has been read). The string's score is the average score of all its characters. To retrieve the score of the string or its characters, call MdmrGetResult() with M_STRING_SCORE or M_CHAR_SCORE. INQ (summarize)Sets the certainty level for the string's score. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies one of the following. (summarize)Specifies one of the following. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 70.0%. |
||||||||||||||||||||||||||||||||||||||
0.0 <= Value <= 100.0 |
Specifies the certainty level for the string score, as a percentage. 100.0% indicates that the string in the target image perfectly resembles the string model (perfection is generally hard to obtain). (summarize)Specifies the certainty level for the string score, as a percentage. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_LABEL_VALUE |
Modifies the label value of the string model. The StringModelLabelOrIndex parameter must specify a specific string model (not all). (summarize)Modifies the label value of the string model. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the string model's new label value. The label value must be greater than 0 and it must be unique among all string models in the context. (summarize)Specifies the string model's new label value. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_RANK |
Sets the order in which to read a string, relative to the other strings to read. Strings with lower ranks are read before those with higher ones. Do not modify rank unless your context has multiple string models. SureDotOCR reads strings from left to right and from top to bottom, relative to the angle of the string's location. If a string model's rank is 0 (M_DEFAULT), SureDotOCR tries to read that string first; accounting for angle, it will be the top left-most string. If multiple string models have identical ranks, SureDotOCR reads just one string, depending on which is more similar to its string model. When specifying ranks, you must include rank 0, and you must not skip successive values. For example, you will get an error if a context has four string models with their ranks set to [1, 2, 3, 4] or [0, 1, 2, 4]. Strings with different ranks must be on separate lines. SureDotOCR uses the rank of the string models in a context to establish the required number of strings to read for that context: TotalNumberOfStringsToRead = HighestRankValue + 1. For example, if you have four string models with ranks set to [0, 0, 1, 2], SureDotOCR must read three strings. If 3 strings cannot be read, no results are returned. Since the default rank for every string model is 0, SureDotOCR will try to read 1 string, regardless of how many string models are in your context, unless you modify rank. INQ (summarize)Sets the order in which to read a string, relative to the other strings to read. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies one of the following. (summarize)Specifies one of the following. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 0. |
||||||||||||||||||||||||||||||||||||||
Value >= 0 |
Specifies the order in which to read a string. Explicitly indicating rank can make the read operation faster and more accurate. (summarize)Specifies the order in which to read a string. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_SIZE_MAX |
Sets the maximum number of characters in the string. This number includes spaces, if they correspond to a space permitted character constraint (M_SPACE). INQ (summarize)Sets the maximum number of characters in the string. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the maximum number of characters. This value must be equal to the minimum number of characters (M_STRING_SIZE_MIN). (summarize)Specifies the maximum number of characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
1 <= Value <= 256 |
Specifies the maximum number of characters. |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_SIZE_MIN |
Sets the minimum number of characters in the string. This number includes spaces, if they correspond to a space permitted character constraint (M_SPACE). INQ (summarize)Sets the minimum number of characters in the string. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the minimum number of characters. This value must be equal to the maximum number of characters (M_STRING_SIZE_MAX). (summarize)Specifies the minimum number of characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 1. |
||||||||||||||||||||||||||||||||||||||
1 <= Value <= 256 |
Specifies the minimum number of characters. |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_STRING_SIZE_MIN_MAX |
Sets the minimum and maximum number of characters in the string. These numbers include spaces, if they correspond to a space permitted character constraint (M_SPACE). M_STRING_SIZE_MIN_MAX is the same as calling this function twice, the first with M_STRING_SIZE_MIN and the second with M_STRING_SIZE_MAX. (summarize)Sets the minimum and maximum number of characters in the string. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the minimum number of characters. This value must be equal to the maximum number of characters. (summarize)Specifies the minimum number of characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Specifies the default value; the default value is 1. |
||||||||||||||||||||||||||||||||||||||
1 <= Value <= 256 |
Specifies the minimum number of characters. |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Specifies the maximum number of characters. This value must be equal to the minimum number of characters. (summarize)Specifies the maximum number of characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
1 <= Value <= 256 |
Specifies the maximum number of characters. |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info: Data
type: Set this parameter to
M_NULL
Data type info: Data
type: Set this parameter to
M_NULL
|
The following ControlType and corresponding ControlValue1, ControlValue2, and ControlValuePtr parameter settings are used to set constraints for the different positions in the string model. In this case, set the StringModelLabelOrIndex parameter to the label or index of a string model (one or all).
To set the default constraints for the positions in the string model, set the Position parameter to M_DEFAULT, unless otherwise specified. To set explicit constraints for a position, set the Position parameter to the required position (one or all).
For setting constraints to the different positions in
the string model
|
|||||||||||||||||||||||||||||||||||||||
|
Description | ||||||||||||||||||||||||||||||||||||||
ControlValue1 | |||||||||||||||||||||||||||||||||||||||
ControlValue2 | |||||||||||||||||||||||||||||||||||||||
ControlValuePtr | |||||||||||||||||||||||||||||||||||||||
M_ADD_PERMITTED_CHARS_ENTRY |
Sets a constraint based on permitted characters. This restricts the characters that can be read, according to a font (ControlValue1) and character type (ControlValue2). For example, you can specify that at position 0, in string model 0, you will only permit the letter 'O', as represented in font OhZero, to be read. Every position in every string model can initially read any character from any font in the context, unless you specify otherwise. Spaces can also be read, depending on the space controls, which you can specify by calling MdmrControl() with M_SPACE_SIZE_MAX and M_SPACE_SIZE_MIN. Unless otherwise specified, permitted character constraints are cumulative. Each time you specify permitted characters, they are added to the previously specified permitted characters, if they exist. (summarize)Sets a constraint based on permitted characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the font that contains the representation of the character to read. The font must be in the specified context. (summarize)Specifies the font that contains the representation of the character to read. (more details...) |
||||||||||||||||||||||||||||||||||||||
Specifies the font by indicating its index, or specifies any font. When you specify a font's index, SureDotOCR internally refers to the font by its corresponding label. If the font's index subsequently changes, which can happen when other fonts are added or deleted, the font you referred to remains the same. (summarize)Specifies the font by indicating its index, or specifies any font. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index of the font. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
Specifies the font by indicating its label, or specifies any font. (summarize)Specifies the font by indicating its label, or specifies any font. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label of the font. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Specifies the type of character to read, relative to the specified font, unless otherwise specified. For example, to read digit type characters from MySuperExcellentFont, set this parameter to M_DIGITS, and set the ControlValue1 parameter to the index or label of MySuperExcellentFont. INQ (summarize)Specifies the type of character to read, relative to the specified font, unless otherwise specified. INQ (more details...) |
||||||||||||||||||||||||||||||||||||||
M_ANY |
Specifies to read all characters present in the font. |
||||||||||||||||||||||||||||||||||||||
M_CHAR_LIST |
Specifies to read an explicit list of characters. To specify them, use the ControlValuePtr parameter. (summarize)Specifies to read an explicit list of characters. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DIGITS |
Specifies to read characters '0' to '9'. |
||||||||||||||||||||||||||||||||||||||
M_LETTERS |
Specifies to read characters 'A' to 'Z' and 'a' to 'z'. |
||||||||||||||||||||||||||||||||||||||
M_LETTERS_LOWERCASE |
Specifies to read characters 'a' to 'z'. |
||||||||||||||||||||||||||||||||||||||
M_LETTERS_UPPERCASE |
Specifies to read characters 'A' to 'Z'. |
||||||||||||||||||||||||||||||||||||||
M_SPACE |
Specifies to read a space. Unlike other permitted characters, fonts cannot represent a space. To establish it, call MdmrControl() with M_SPACE_SIZE_MAX and M_SPACE_SIZE_MIN. When specifying M_SPACE, set the ControlValue1 parameter to the index or label of any font (M_ANY). To use M_SPACE, the Position parameter must be set to a specific position that is not the first or last position in a string model. That position cannot have another character constraint nor can you have consecutive positions with a space constraint. If these conditions are not followed, you will get an error. Reading an M_SPACE character does not necessarily mean that the corresponding space position in the target string is blank. SureDotOCR attempts to read the best string possible, and can use the space constraint as an area to ignore, even if that area is not empty. For example, if you have an icon at a specific position within a target string, you can specify a space at that position. (summarize)Specifies to read a space. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info:
Data type: Set this
parameter to M_NULL |
address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ]
MORE
Specifies a null-terminated string indicating the names of the characters supported at a specified position, when ControlValue2 is set to M_CHAR_LIST. Character names must refer to specific letters (such as 'o'), digits (such as '0'), and punctuation marks (such as '%') in the font. You cannot indicate a space when listing characters for M_CHAR_LIST. The specified string can contain one or more character names. List them all without separators. For example, to read the twenty-second, the ninth, and the third uppercase letters of the alphabet, use the string "VIC". Specifying multiple characters is equivalent to calling this function multiple times, and listing one character each time. You can list character names in hexadecimal format beginning with "\\x". This is necessary if you are in an ASCII environment and you want Unicode characters beyond the Basic Latin range. For example, Basic Latin does not include the smiley face character; to specify it, use "\\x263A". You can also list a string of character names with mixed notation; in this case, you should also use "\\x" (for example, "VIC\\x263A"). INQ (summarize)
Data type info:
Data type: Set this
parameter to M_NULL |
address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ]
MORE
Specifies a null-terminated string indicating the names of the characters supported at a specified position, when ControlValue2 is set to M_CHAR_LIST. INQ (more details...) |
The following ControlType and corresponding ControlValue1, ControlValue2, and ControlValuePtr parameter settings are used to generally control the different positions in the string model(s). In this case, set the StringModelLabelOrIndex parameter to the label or index of a string model (one or all).
Depending on the control type selected, you can control the default constraints for the positions in the string model (set the Position parameter to M_DEFAULT), or you can control the explicit constraints for a position (set the Position parameter to one or all positions).
For generally controlling the different positions in
the string model
|
|||||||||||||||||||||||||||||||||||||||
|
Description | ||||||||||||||||||||||||||||||||||||||
ControlValue1 | |||||||||||||||||||||||||||||||||||||||
ControlValue2 | |||||||||||||||||||||||||||||||||||||||
ControlValuePtr | |||||||||||||||||||||||||||||||||||||||
M_CLONE_CONSTRAINTS_FROM |
Clones the explicit constraints from the source to the destination. The string model position specified with the ControlValue1 and ControlValue2 parameters represents the source. The string model position specified with the StringModelLabelOrIndex and Position parameters represents the destination. If the destination is a specific position (one or all), it will be explicitly constrained according to the explicit constraints of the source. Explicit constraints already specified for the destination will be overwritten. Only the cloned ones will remain. If the destination refers to the default constraints for the positions in the string model, all its implicitly constrained positions will be identical to the explicitly constrained position identified by the source. The clone operation does not override the state of the positions in the source; they remain implicitly constrained. (summarize)Clones the explicit constraints from the source to the destination. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies the string model that has the explicit constraints to clone. (summarize)Specifies the string model that has the explicit constraints to clone. (more details...) |
||||||||||||||||||||||||||||||||||||||
Specifies the string model by indicating its index. (summarize)Specifies the string model by indicating its index. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the index of the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
Specifies the string model by indicating its label. (summarize)Specifies the string model by indicating its label. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the label of the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Specifies the position that has the explicit constraints to clone. (summarize)Specifies the position that has the explicit constraints to clone. (more details...) |
||||||||||||||||||||||||||||||||||||||
Specifies an explicitly constrained position in the string model by indicating the order in which the position was explicitly constrained. (summarize)Specifies an explicitly constrained position in the string model by indicating the order in which the position was explicitly constrained. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Set this parameter to the following: |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
Specifies a position in the string model. (summarize)Specifies a position in the string model. (more details...) |
|||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
Specifies the position in the string model. |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info:
Data type: Set this
parameter to M_NULL
Data type info:
Data type: Set this
parameter to M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_DELETE_PERMITTED_CHARS_ENTRY |
Deletes a character constraint at a specific index. (summarize)Deletes a character constraint at a specific index. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Specifies which character constraint to delete. (summarize)Specifies which character constraint to delete. (more details...) |
||||||||||||||||||||||||||||||||||||||
M_DEFAULT |
Same as M_ALL. |
||||||||||||||||||||||||||||||||||||||
M_ALL |
Specifies to delete all character constraints. The permitted character constraints revert to those of the default constraint. (summarize)Specifies to delete all character constraints. (more details...) |
||||||||||||||||||||||||||||||||||||||
0<=Value<M_NUMBER_OF_PERMITTED_CHARS_ENTRIES |
Specifies to delete the character constraint at the specified index. |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info:
Data type: Set this
parameter to M_NULL
Data type info:
Data type: Set this
parameter to M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_RESET_IMPLICIT_CONSTRAINTS |
Resets the implicit (default) constraints for the positions in the string model back to their initial value. You can only use M_RESET_IMPLICIT_CONSTRAINTS if the Position parameter is set to M_DEFAULT. Initially, any character from any font can be read at every string model position. (summarize)Resets the implicit (default) constraints for the positions in the string model back to their initial value. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info:
Data type: Set this
parameter to M_NULL
Data type info:
Data type: Set this
parameter to M_NULL
|
||||||||||||||||||||||||||||||||||||||
M_RESET_POSITION_TO_IMPLICIT_CONSTRAINTS |
Resets the explicitly constrained position(s) to the implicit (default) constraints for the string model. These positions are then considered implicitly constrained. You can only use M_RESET_POSITION_TO_IMPLICIT_CONSTRAINTS if the Position parameter is not set to M_DEFAULT. The constrained order (M_POSITION_CONSTRAINED_ORDER()) of a position changes when you use M_RESET_POSITION_TO_IMPLICIT_CONSTRAINTS. (summarize)Resets the explicitly constrained position(s) to the implicit (default) constraints for the string model. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue1 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValue2 |
Set this parameter to M_DEFAULT. (summarize)Set this parameter to M_DEFAULT. (more details...) |
||||||||||||||||||||||||||||||||||||||
ControlValuePtr |
Data type info:
Data type: Set this
parameter to M_NULL
Data type info:
Data type: Set this
parameter to M_NULL
|
void MdmrControlStringModelInt64 (MIL_ID ContextDmrId,
MIL_INT64
StringModelLabelOrIndex, MIL_INT64 Position,
MIL_INT64 ControlType,
MIL_INT64 ControlValue1,
MIL_INT64 ControlValue2,
const void *ControlValuePtr)
Parameters
ContextDmrId See ContextDmrId of the main function for a description. StringModelLabelOrIndex See StringModelLabelOrIndex of the main function for a description. Position See Position of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue1 See ControlValue1 of the main function for a description. ControlValue2 See ControlValue2 of the main function for a description. ControlValuePtr See ControlValuePtr of the main function for a description. |
void MdmrControlStringModelDouble (MIL_ID ContextDmrId,
MIL_INT64
StringModelLabelOrIndex, MIL_INT64 Position,
MIL_INT64 ControlType,
MIL_DOUBLE ControlValue1,
MIL_DOUBLE ControlValue2,
const void *ControlValuePtr)
Parameters
ContextDmrId See ContextDmrId of the main function for a description. StringModelLabelOrIndex See StringModelLabelOrIndex of the main function for a description. Position See Position of the main function for a description. ControlType See ControlType of the main function for a description. ControlValue1 See ControlValue1 of the main function for a description. ControlValue2 See ControlValue2 of the main function for a description. ControlValuePtr See ControlValuePtr of the main function for a description. |
Header | Include mil.h. |
Library | Use mil.lib; mildmr.lib. |
DLL | Requires mil.dll; mildmr.dll. |