| Customize Help
| Save Settings

M3dregSave


Function Map
Syntax
Description
Parameters
- FileName
Table: For specifying the file name and path
- ContextOrResult3dregId
- ControlFlag
Compilation information
Synopsis
Save a 3D registration context or 3D registration result buffer to a file.
Syntax
void M3dregSave(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID ContextOrResult3dregId, //in
MIL_INT64 ControlFlag //in
)
Description

This function saves all the information about a previously allocated 3D registration context or 3D registration result buffer to disk.

To load a saved context or result, use either M3dregRestore() or M3dregStream().

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 3D registration context or 3D registration result buffer. It is recommended that you use the M3DREG file extension for easier use with other Matrox Imaging software products. The function handles (internally) 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:

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

Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). The recommended extension is M3DREG.

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

ContextOrResult3dregId

Specifies the identifier of the 3D registration context or 3D registration result buffer to save. These must have been successfully allocated (using M3dregAlloc() or M3dregAllocResult()) prior to calling this function.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

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