| MIL 10 Reference
| Customize Help
| Save Settings

MregSave


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
None.
MregRestore
MregSetLocation
Synopsis
Save a registration context or the contents of a registration result buffer to a file.
Syntax
void MregSave(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID ContextOrResultId, //in
MIL_INT64 ControlFlag //in
)
Description

This function saves all the information about the previously allocated registration context or registration result buffer to disk. This information can be reloaded, using MregRestore() or MregStream(). Saving the result buffer is useful if you want the reuse the registration results. Note that you cannot save an M_EXTENDED_DEPTH_OF_FIELD_RESULT result buffer.

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 registration context or the contents of the registration result buffer. It is recommended that you use the MRF file extension for easier use with other Matrox Imaging software products. The function handles (internally) the opening and closing of the file.

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

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

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)

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

ContextOrResultId

Specifies either the identifier of the registration context or the registration result buffer to save.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information
Header Include mil.h.
Library Use mil.lib; milreg.lib.
DLL Requires mil.dll; milreg.dll.
INTERACTIVE