Click here to show toolbars of the Web Online Help System: show toolbars
 

| Customize Help
| Save Settings

MimRestore


Function Map
Syntax
Description
Parameters
- FileName
Table: For specifying the file name and path
- SysId
Table: For specifying the system identifier
- ControlFlag
- ContextImIdPtr
Return value
Compilation information
Synopsis
Restore an image processing context from disk.
Syntax
MIL_ID MimRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_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 that this function allocates the imaging processing context for you. To load an image processing context into an existing image processing context, allocate the context using MimAlloc() and then use MimStream() with M_LOAD.

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

This parameter can be set to one of the following:

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 Open 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"). Typically, image processing context files have an MIC 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)

1 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 image processing context. This parameter should be set to one of the following values:

function map For specifying the system identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ContextImIdPtr

Specifies the address of the variable in which to write the image processing context identifier. Since this function also returns the 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 image processing context identifier. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milim.lib.
DLL Requires mil.dll; milim.dll.
INTERACTIVE DEFAULT HOST