| Customize Help
| Save Settings

MmeasRestoreMarker


Function Map
Syntax
Description
Parameters
- FileName
Table: For specifying the file name and path
- SystemId
Table: For specifying the system identifier
- ControlFlag
- MarkerIdPtr
Return value
Compilation information
Synopsis
Restore a marker from disk.
Syntax
MIL_ID MmeasRestoreMarker(
MIL_CONST_TEXT_PTR FileName, //in
MIL_ID SystemId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *MarkerIdPtr //out
)
Description

This function restores a marker that was previously saved, using MmeasSaveMarker() or MmeasStream(), and returns a handle to it. It also restores all the marker characteristics that were in effect when the marker was saved.

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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
FileName

Specifies the name and path of the file from which to restore the marker. 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, marker files have an MRK 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().

SystemId

Specifies the system on which to restore the measurement marker.

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.

MarkerIdPtr

Specifies the address of the variable in which the marker identifier is to be written. Since the MmeasRestoreMarker() function also returns the marker 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 marker identifier. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milmeas.lib.
DLL Requires mil.dll; milmeas.dll.
INTERACTIVE DEFAULT HOST