MstrRestore

See also

User Guide:

Adding and deleting string models to the context Steps to reading a string in an image Using a fontless context

Reference:

MstrPreprocess MstrRead MstrSave MstrStream 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

tirestringread.cpp
usdotnumberstr.cpp

Function Map

- FileName

Table:

For specifying the file name and path

- SystemId

Table:

For specifying the system identifier

- ControlFlag

- ContextIdPtr

Return value

Compilation information

Synopsis

Restore a String Reader context from disk.

Syntax

MIL_ID MstrRestore(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_ID SystemId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ContextIdPtr	//out

)

Description

This function restores a String Reader context that was previously saved to a file, using MstrSave() or MstrStream(). This function restores all of the String Reader context's settings (including font and string model settings) that were in effect when the String Reader context was saved. A restored String Reader context is not preprocessed; therefore, you must call MstrPreprocess() before performing a read with MstrRead().

To use a fontless context, you must restore one of the predefined context files distributed with MIL (such as, "C:\Program Files\Matrox Imaging\contexts\FONTLESS_ANPR.msr").

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 String Reader context (for example, "C:\mydirectory\myfile"). The function handles (internally) the opening and closing of the file.

The predefined context files, distributed with MIL, are in the "C:\Program Files\Matrox Imaging\contexts\FONTLESS_ANPR.msr" 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("FONTLESS_ANPR.msr") ¹	Specifies to restore a generic String Reader context useful to read license plates.
MIL_TEXT("FONTLESS_EUROPEAN_ANPR.msr") ¹	Specifies to restore a String Reader context useful to read European license plates.
MIL_TEXT("FONTLESS_MACHINE_PRINT.msr") ¹	Specifies to restore a special String Reader context that reads machine printed characters in Arial, OCR-B, or other sans-serif fonts.

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

SystemId

Specifies the system on which to restore the String Reader context.

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().

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextIdPtr

Specifies the address of the variable in which to write the String Reader context identifier. Since this function also returns the String Reader context identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

Return value

The returned value is the String Reader context identifier. If allocation fails, M_NULL is returned.

Compilation information

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