Loading Reference... User Guide... Hardware-specific Notes...

Customize Help

MIL systems:
Show All

Installed MIL systems

Multiple

None

Host system

Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)*

Matrox Morphis

Matrox Morphis QxT

Matrox Orion HD

Matrox Radient eCL

Matrox Radient eV-CXP (MIL 10 or Update 29)*

Matrox Solios eA/XA

Matrox Solios ecl/xcl/ev-cl

Matrox USB3 Vision driver (Update 19)

Matrox RadientPro-CL (Update 7)

Matrox Radient eV-CL (Update 27 or 74)

Matrox Iris GTR (Update 28 or Update 68)

Matrox Clarity UHD (Update 36 or 76)

Matrox GenTL driver (Update 34)

Matrox Indio (Update 53 or Update 68)

Matrox Rapixo CXP (Update 75 or Update 84)

Matrox Concord PoE with ToE (Update 82)

Matrox Rapixo CL Pro (Update 96)

As Tooltip

Value descriptions: Detailed Summarized

Save Settings

M3dimRestore

See also

Reference:

M3dimSave M3dimStream MsysAlloc

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/GPm

Available on Matrox Supersight

Function map

Examples

None.

Function Map

- FileName

Table:

For specifying the file name and path

- SysId

Table:

For specifying the system identifier

- ControlFlag

- Context3dimIdPtr

Return value

Compilation information

Synopsis

Restores a 3D image processing context from disk.

Syntax

MIL_ID M3dimRestore(

MIL_CONST_TEXT_PTR FileName,	//in
MIL_ID SysId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *Context3dimIdPtr	//out

)

Description

This function restores a 3D image processing context that was previously saved to a file, using M3dimSave() or M3dimStream(). This function restores all of the 3D image processing context's settings that were in effect when it was saved.

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 from which to restore the 3D image processing context. The function handles (internally) the opening and closing of the file.

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("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Typically, 3D image processing context files have an M3DIM extension. 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().

SysId

Specifies the system on which to restore the 3D image processing 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.

Context3dimIdPtr

Specifies the address of the variable in which to write the 3D image processing context identifier. Since this function also returns the 3D image processing 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 3D image processing context identifier. If allocation fails, M_NULL is returned.

Compilation information

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