MimRestore

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Restore an image processing context from disk.

Syntax

AIL_ID MimRestore(
    AIL_CONST_TEXT_PTR FileName,       //in
    AIL_ID             SysId,          //in
    AIL_INT64          ControlFlag,    //in
    AIL_ID *           ContextImIdPtr  //out
)

Description

This function restores an image processing context that was previously saved to a file using MimSave or MimStream. This function restores all of the image processing context's settings that were in effect when the image processing context was saved.

Note: Note that this function allocates the image processing context for you. To load an image processing context into an existing image processing context, allocate the context usingMimAlloc and then use MimStream with M_LOAD.

When the restored image processing context is no longer required, release it usingMimFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the restored image processing context's lifetime and you must not manually free it.

Parameters

FileName (in, AIL_CONST_TEXT_PTR)

Specifies the name and path of the file from which to restore the image processing context. The function handles (internally) the opening and closing of the file.

For specifying the file name and path

Value	Description
M_INTERACTIVE	Opens the File Open dialog box from which you can interactively specify the drive, directory, and name of the file.
"FileName"	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). Typically, image processing context files have an MIC extension.

To specify a file on a remote computer (under Distributed Aurora Imaging Library), prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"). |

SysId (in, AIL_ID)

Specifies the system on which to restore the 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 Aurora Imaging Library application.
System identifier	Specifies a valid system identifier, previously allocated using MsysAlloc.

ControlFlag (in, AIL_INT64)

Reserved for future expansion and must be set to M_DEFAULT.

ContextImIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the image processing context identifier or specifies the data type that the function should use to return the restored image processing context identifier.

For retrieving the identifier or specifying how to return it

Value	Description
M_NULL	Specifies that you will use this function's return value to obtain the identifier of the allocated image processing context; in this case, a standard Aurora Imaging Library identifier of type AIL_ID is returned.
M_UNIQUE_ID	Specifies that you will use this function's return value to obtain the identifier of the allocated image processing context; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_IM_ID_is returned instead of a standard Aurora Imaging Library identifier.This setting is only available when using C++11 (or later).An Aurora Imaging Library smart identifier manages the lifespan of the Aurora Imaging Library object it owns (similar to a std::unique_ptr). Note, you can use an Aurora Imaging Library smart identifier as though it were a standard Aurora Imaging Library identifier, except that you cannot use it to manually free the image processing context (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers.
Address in which to write the identifier	Specifies the address of an AIL_ID in which to write the identifier of the restored image processing context.

If allocation fails, M_NULL is written as the identifier. |

Return Value

Type: AIL_ID

The returned value is the restored image processing context identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_IM_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).