MocrRestoreFont

See also

User Guide:

OCR font Steps to reading or verifying a string in an image

Reference:

MocrFree MocrSaveFont MsysAlloc

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux with restrictions

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

mocr.cpp
mocr.cs
mocr.vb
multiviewannotations.cpp
semiocr.cpp

Function Map

- FileName

Table:

For specifying the file name and path

- Operation

Table:

For specifying the type of data to restore

- SystemId

Table:

For specifying the system identifier

- FontContextOcrIdPtr

Return value

Compilation information

Synopsis

Restore an OCR font context, font constraint data, or control data from file.

Syntax

MIL_ID MocrRestoreFont(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_INT64 Operation,	//in
MIL_ID SystemId,	//in
MIL_ID *FontContextOcrIdPtr	//in-out

)

Description

This function restores an OCR font context that was previously saved to a file using MocrSaveFont().

This function can also restore a font context from a predefined font context file distributed with MIL (such as, C:\Program Files\Matrox Imaging\contexts\ Semi_M12-92.mfo). Alternatively, this function can load only font constraint or control data from the file into the specified OCR font context.

When an OCR font context is no longer required, it should be freed with MocrFree().

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

FileName

Specifies the path and name of the file from which to restore the MIL OCR font context (for example, "C:\mydirectory\myfile"). The function handles (internally) the opening and closing of the file.

The predefined font files, distributed with MIL, are in the "C:\Program Files\Matrox Imaging\contexts\" folder.

To open the file on the remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile").

This parameter can be set to one of the following:

For specifying the file name and path
Value	Description
M_INTERACTIVE	[This is only applicable to Windows] Opens the File Open dialog box from which you can interactively specify the drive, directory, and name of the file.
MIL_TEXT("Filename.mfo") ¹	Specifies to restore an OCR user-defined font.
MIL_TEXT("MICR_CMC_7.mfo") ¹	Specifies to restore an OCR font context typically used with the MICR CMC7 standard.
MIL_TEXT("MICR_E_13B.mfo") ¹	Specifies to restore an OCR font context typically used with the MICR E-13b standard.
MIL_TEXT("OCR_A_BT.mfo") ¹	Specifies to restore an OCR font context that uses the OCR-A BT font.
MIL_TEXT("OCR_B_BT.mfo") ¹	Specifies to restore an OCR font context that uses the OCR-B BT font.
MIL_TEXT("SEMI_M12-92.mfo") ¹	Specifies to restore an OCR font context following the SEMI M12 standard.
MIL_TEXT("SEMI_M13-88.mfo") ¹	Specifies to restore an OCR font context following the SEMI M13 standard.
MIL_TEXT("SEMI.mfo") ¹	Specifies to restore an OCR font context typically used with the SEMI conductor standard.

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

Operation

Specifies which type of OCR font context data to restore. It can be set to one of the following values:

For specifying the type of data to restore
Value	Description
M_DEFAULT	Same as M_RESTORE.
M_LOAD_CONSTRAINT	Loads only font constraint data into the specified OCR font context.
M_LOAD_CONTROL	Loads only font control data into the specified OCR font context.
M_RESTORE	Allocates a new OCR font context on the specified system, and initializes it with the font, control, and constraint data, restored from file.

SystemId

Specifies the system on which the OCR font context is allocated.

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

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

FontContextOcrIdPtr

Specifies the address of the variable to/from which the font identifier is to be written/read.

Since after performing a restore operation, MocrRestoreFont() also returns the OCR font context identifier, this parameter can be set to M_NULL. If the restore operation fails, M_NULL is returned as the identifier.

Return value

Returns the identifier of the existing or newly allocated OCR font context. If allocation fails, M_NULL is returned as the identifier.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milocr.lib.
DLL	Requires mil.dll; milocr.dll.