MmetRestore

This function restores a MIL metrology context that was previously saved to a file, using MmetSave() or MmetStream(). This function restores all the metrology context's settings and names that were in effect when the metrology context was saved.

If you had associated a calibration context with the template reference in your metrology context and you did not save it with the context, you must re-associate the calibration context, using MmetControl() with M_ASSOCIATED_CALIBRATION. Moreover, if you had previously set drawing control types, using MgraControl() with M_DRAW_..., you must reset them since they were not saved with the context.

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 metrology 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"). 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 metrology 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

Specifies whether to restore, from the metrology context, the calibration context associated with the template reference.

For specifying whether to restore the calibration context associated with the template reference
Value	Description
M_DEFAULT	Specifies that the calibration context is not restored.
M_WITH_CALIBRATION	Specifies that the calibration context is restored. In this case, the calibration context must have been previously saved with the context, using MmetSave() or MmetStream() with M_WITH_CALIBRATION. The calibration information is restored from the same file as the metrology context. The calibration cannot be managed independently from the metrology context. When the metrology context is freed, the calibration is automatically freed as well. (summarize) Specifies that the calibration context is restored. (more details...)

ContextIdPtr

Specifies the address of the variable in which to write the metrology context identifier. Since MmetRestore() also returns the metrology 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 metrology context identifier. If allocation fails, M_NULL is returned.

Compilation information

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