| MIL 10 Reference
| Customize Help
| Save Settings

MbeadRestore


See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
None.
MbeadInquire
MbeadSave
Synopsis
Restore a bead context from disk.
Syntax
MIL_ID MbeadRestore(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ContextBeadIdPtr //out
)
Description

This function restores a bead context that was previously saved to a file, using MbeadSave() or MbeadStream(). This function restores all of the bead context's settings that were in effect when it was saved. The templates of a restored bead context are not trained, therefore you must call MbeadTrain() before performing a verification with MbeadVerify().

If you had associated a calibration context with the training image and you did not save it with the context, you must re-associate the calibration context, using MbeadControl() with M_ASSOCIATED_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 bead context. The function handles (internally) the opening and closing of the file.

This parameter should be set to the following value:

function map For specifying the file name and path
CollapseValue Description
Collapse MIL_TEXT("FileName") 1

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)

1 If you are passing the value in a variable, don't enclose it in MIL_TEXT().

SysId

Specifies the identifier of the system on which to restore the bead 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

Specifies whether to restore the calibration context that was saved with the bead context.

function map For specifying whether to restore the calibration context that was saved with the bead context
CollapseValue Description
Collapse M_DEFAULT

Specifies that the calibration is not restored.
Collapse M_WITH_CALIBRATION

Specifies that the calibration is restored. In this case, the calibration must have been previously saved with the context, using MbeadSave() or MbeadStream() with M_WITH_CALIBRATION.

The calibration information is restored from the same file as the bead context. The calibration cannot be managed independently from the bead context. When the bead context is freed, the calibration is automatically freed as well.

(summarize)
ContextBeadIdPtr

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