| Customize Help
| Save Settings

MdmrName



Function Map
Synopsis
Perform name operations for fonts and string models.
Syntax
void MdmrName(
MIL_ID ContextDmrId, //in
MIL_INT64 Operation, //in
MIL_INT64 LabelOrIndex, //in
MIL_TEXT_PTR Name, //in-out
MIL_INT *ValuePtr, //out
MIL_INT64 ControlFlag //in
)
Description

This function allows you to perform name operations for fonts and string models in a SureDotOCR context. Use this function to set the name of a font or string model, release the name of a font or string model, or retrieve either the label or index of a font or string model based on its name. These operations allow you to more easily manage your data; they do not impact how strings are processed and read.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ContextDmrId

Specifies the identifier of the SureDotOCR context containing the font or string model with which to perform the name operation. The context must have been previously allocated on the system using MdmrAlloc().

Operation

Specifies the name operation to perform. Set this parameter to one of the values below. Unless otherwise specified, the LabelOrIndex parameter can specify a font or string model, the Name parameter must specify the name information related to the operation, and the ValuePtr parameter must specify the address at which to write the information requested by the name operation.

function map For specifying the name operation
Click to summarizeValue Description
Click to summarize M_GET_FONT_INDEX

Retrieves the index of the font, based on the specified name. Set the LabelOrIndex parameter to M_DEFAULT.

(summarize)
Click to summarize M_GET_FONT_LABEL

Retrieves the label of the font, based on the specified name. Set the LabelOrIndex parameter to M_DEFAULT.

(summarize)
Click to summarize M_GET_NAME

Retrieves the name, and name length, of the specified font or string model.

Use the Name parameter to retrieve the name. Use the ValuePtr parameter to retrieve the length of the name.

(summarize)
Click to summarize M_GET_STRING_INDEX

Retrieves the index of the string model, based on the specified name. Set the LabelOrIndex parameter to M_DEFAULT.

(summarize)
Click to summarize M_GET_STRING_LABEL

Retrieves the label of the string model, based on the specified name. Set the LabelOrIndex parameter to M_DEFAULT.

(summarize)
Click to summarize M_SET_NAME

Sets the name of the font or string model, or releases the name of the font or string model.

When setting a name, ensure it is not already used. All font names must be unique among font names and all string model names must be unique among string model names.

When releasing a name, set the Name parameter to M_NULL. Once released, you can use the name again.

(summarize)
LabelOrIndex

Specifies the label or index value of the font or string model with which to perform the name operation. Set this parameter to M_DEFAULT when not required by the name operation.

function map For specifying the label or index value
Click to summarizeValue Description
Click to summarize

Specifies a font by indicating its index.

(summarize)
Parameters

Set this parameter to the following:

0 <= Value < M_NUMBER_OF_FONTS

Specifies the index of the font.

Click to summarize

Specifies a font by indicating its label.

(summarize)
Parameters

Set this parameter to the following:

Value > 0

Specifies the label of the font.

Click to summarize

Specifies a string model by indicating its index.

(summarize)
Parameters

Set this parameter to the following:

0 <= Value < M_NUMBER_OF_STRING_MODELS

Specifies the index of the string model.

Click to summarize

Specifies a string model by indicating its label.

(summarize)
Parameters

Set this parameter to the following:

Value > 0

Specifies the label of the string model.

Name

Specifies the name. Use this parameter to set, get, or release the name, depending on the name operation. If the operation is getting a label and it fails, SureDotOCR returns 0. If the operation is getting an index and it fails, SureDotOCR returns -1. To release the name of a font or string model, set this parameter to M_NULL and specify M_SET_NAME.

ValuePtr

Specifies the address at which to write the information requested by the name operation.

Set this parameter to M_NULL when not required by the name operation.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information
Header Include mil.h.
Library Use mil.lib; mildmr.lib.
DLL Requires mil.dll; mildmr.dll.
GET FONT INDEX GET FONT LABEL GET NAME GET STRING INDEX GET STRING LABEL SET NAME NUMBER OF FONTS NUMBER OF STRING MODELS GET NAME GET NAME