| MIL 10 Reference
| Customize Help
| Save Settings

MstrRestore


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux with restrictions

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MstrRead
MstrSave
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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
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:

function map For specifying the file name and path
CollapseValue Description
Collapse 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.
Collapse MIL_TEXT("FONTLESS_ANPR.msr") 1

Specifies to restore a generic String Reader context useful to read license plates.
Collapse MIL_TEXT("FONTLESS_EUROPEAN_ANPR.msr") 1

Specifies to restore a String Reader context useful to read European license plates.
Collapse MIL_TEXT("FONTLESS_MACHINE_PRINT.msr") 1

Specifies to restore a special String Reader context that reads machine printed characters in Arial, OCR-B, or other sans-serif fonts.

1 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:

function map For specifying the system identifier
CollapseValue Description
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse 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.
INTERACTIVE DEFAULT HOST