| MIL 10 Reference
| Customize Help
| Save Settings

MbeadSave


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.
MbeadRestore
MbeadStream
Synopsis
Save a bead context to a file.
Syntax
void MbeadSave(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID ContextBeadId, //in
MIL_INT64 ControlFlag //in
)
Description

This function saves all the information about the previously allocated bead context to disk, including the current settings of each template. This information can be reloaded, using MbeadRestore() or MbeadStream().

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 in which to save the bead context. It is recommended that you use the BCF file extension for easier use with other Matrox Imaging software products. The function internally handles the opening and closing of the file. If this file already exists, it will be overwritten.

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().

ContextBeadId

Specifies the identifier of the bead context to save.

ControlFlag

Specifies whether to save the calibration context associated with the training image.

function map For specifying whether to save the calibration context associated with the training image
CollapseValue Description
Collapse M_DEFAULT

Specifies that the calibration is not saved.
Collapse M_WITH_CALIBRATION

Specifies that the calibration is saved. The calibration information is saved in the same file as the bead context.

(summarize)
Compilation information
Header Include mil.h.
Library Use mil.lib; milbead.lib.
DLL Requires mil.dll; milbead.dll.
DEFAULT WITH CALIBRATION