VeriStand .NET API Reference

Table of Contents

IMacroPlayer Members

The IMacroPlayer type exposes the following members.

NameDescription
GetCommandLines Gets the currently loaded command lines. You can use the members of the CommandLineInfo class of the NationalInstruments.VeriStand.WorkspaceMacro assembly to get information about the command lines this method returns.
LoadMacro Loads a previously recorded macro (.nivsmacro) file for playback.
PausePlaying Pauses the playback of a macro file.
PlayMacro Runs the Macro Player tool and specifies the speed at which to play back macro files.
PlayState Gets the current state of the Macro Player tool.
ResumePlaying Resumes the playback of a macro file. This method plays back the file from the point at which the PausePlaying method paused playback.
StopPlaying Stops the Macro Player. This method returns the Macro Player to the idle state and resets the macro you are playing back to the beginning of the recording. If you want to be able to resume playback from the place where you stop it, use the PausePlaying method instead.
Wait Waits for the Macro Player tool to finish playing back the current macro file before returning and continuing execution.

Events

NameDescription
OnMacroCommandLine Callback invoked just before executing a Macro Player command.
OnMacroComplete Callback invoked when the Macro Player completes execution.
OnMacroErrorMessage Callback invoked if an error occurs while attempting to execute a Macro Player command.
OnMacroPercentComplete Callback invoked after executing a Macro Player command. The percent is calculated using the length of time a command takes to execute relative to the total time required for all commands to execute.

See Also

Log in to get a better experience