MmeasRestoreMarker()函数

Synopsis

Restore a marker from disk.

Format

MIL_ID MmeasRestoreMarker(FileName, SystemId, ControlFlag, MarkerIdPtr)

Description

This function restores a previously saved marker from disk and returns a handle to it. It also restores all the marker parameters that were in effect when the marker was saved.

The FileName parameter specifies the marker file name. The function internally handles the opening and closing of the file.

The SystemId parameter specifies the system on which the measurement marker will be restored. This parameter must be set to a valid system identifier, M_DEFAULT_HOST, or M_DEFAULT. Specify M_DEFAULT_HOST to allocate on the default Host system of the current MIL application. Specify M_DEFAULT to have MIL select the most appropriate system on which to allocate the buffer (it can be the default Host system or any already allocated system).

The ControlFlag parameter specifies the restore control flag and should be set to M_DEFAULT.

The MarkerIdPtr parameter specifies the address of the variable in which the marker buffer 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.

Returned value

The returned value is the marker buffer identifier. If allocation fails, M_NULL is returned.

See also

MmeasSaveMarker