| MIL 10 Reference
| Customize Help
| Save Settings

McolRestore


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
McolProject
McolSave
Synopsis
Restore a color matching or relative color calibration context from disk.
Syntax
MIL_ID McolRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SystemId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ContextIdPtr //out
)
Description

This function restores a color matching or relative color calibration context that was previously saved to a file, using McolSave() or McolStream(). This function restores all of the context's settings (and color-samples) that were in effect when the context was saved. A restored context is not preprocessed; therefore, you must call McolPreprocess() before calling McolMatch() (color matching) or McolTransform() (relative color calibration).

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

Set this parameter 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 Open 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"). For easier use with other Matrox Imaging software products, files for color matching contexts should use the MCOL file extension. Files for relative color calibration contexts should use the MCCC file extension.

To specify the file on the 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().

SystemId

Specifies the system on which to restore the context. This parameter should be set to one of the following values:

function map For specifying the system identifier
CollapseValue Description
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Collapse MIL system identifier

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

Reserved for future expansion and must be set to M_DEFAULT.

ContextIdPtr

Specifies the address of the variable in which to write the context identifier. If allocation fails, M_NULL is written as the identifier. Since McolRestore() also returns the context identifier, you can set this parameter to M_NULL.

Return value
The returned value is the context identifier. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milcolor.lib.
DLL Requires mil.dll; milcolor.dll.
INTERACTIVE DEFAULT HOST