MstrSave

This function saves all the information about the previously allocated String Reader context to disk, including all of the individual font and string settings. This information can be reloaded, using MstrRestore() or MstrStream().

When you save the String Reader context, the preprocessing changes are not saved. Upon restoration, you must preprocess the context again.

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 name and path of the file in which to save the String Reader context. It is recommended that you use the MSR file extension for easier use with other Matrox Imaging software products. The function internally handles the opening and closing of this file. If this file already exists, it will be overwritten.

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

For specifying the file name and path
Value	Description
M_INTERACTIVE	[This is only applicable to Windows] Opens the File Save As dialog box from which you can interactively specify the drive, directory, and name of the file.
MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). To specify a file on a remote computer (under Distributed MIL), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). (more details...)

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

ContextId

Specifies the identifier of the String Reader context to save.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information

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