Brief Descriptions of ScanWorksAPI and National Instruments VI Functions
Function Purpose
sw_ClearExecutionResults Clears the results for the sequence currently loaded, and deletes the result files
sw_connect Connecting to ScanWorks
sw_DeleteProject Deletes project
sw_DiagnoseAction Diagnose the currently loaded action
sw_disconnect Disconnecting from ScanWorks
sw_GetActionCount Get number of actions in currently loaded design
sw_GetActionNameAt Get name of action at index
sw_GetActionNotesName Copies any action notes related to the action that is currently loaded into the file name provided
sw_GetDesignCount Get number of designs in currently loaded project
sw_GetDesignNameAt Get name of design description at index
sw_GetDesignNotesName Copies any notes related to the design description that is currently loaded into the file name provided
sw_GetError Get last error
sw_GetErrorMessage Get last error message
sw_GetProjectCount Get number of projects
sw_GetProjectNameAt Get project name at index
sw_GetProjectNotesName Copies any project notes related to the project that is currently loaded into the file name provided
sw_GetReportFileName For report title specified, get fully-qualified report file name for currently loaded action
sw_GetReportFileNameAt Get report name and title at index
sw_GetReportFileNameCount Get number of report files generated
sw_GetSequenceCount Gets the number of sequences in the currently-loaded project
sw_GetSequenceCountByDesign Gets the number of ScanWorks sequences within the open project that target the specified design description
sw_GetSequenceMappingStatus Gets pass/fail status for the specified mapping of the sequence currently loaded
sw_GetSequenceNameAt Gets the name of the sequence at the specified index
sw_GetSequenceNameByDesignAt Gets the name of the ScanWorks sequence at the index specified. Sequence targets the specified design description
sw_GetSequenceNotesName Gets the sequence notes and copies them into the file specified
sw_GetSequenceReportFile Gets the name and path for the results file (HTML version) for the sequence currently loaded
sw_GetSequenceSummaryReport Gets the name and path for the results file (text version) for the sequence currently loaded
sw_GetStepCount Gets the number of steps in the sequence currently loaded
sw_GetStepNameAt Gets the name of the step at the specified index in the sequence currently loaded
sw_GetStepStatus Gets the pass/fail status of the specified step in the sequence currently loaded
sw_ImportProjectTo Import project
sw_LoadAction Load an action by name
sw_LoadActionAt Load an action by number
sw_LoadDesign Load a design description by name
sw_LoadDesignAt Load a design description by number
sw_LoadProject Load a project by name
sw_LoadProjectAt Load a project by number
sw_LoadSequence Loads a sequence specified by name
sw_LoadSequenceAt Loads a sequence specified by index
sw_MT_GetMappingCount Get number of mappings available
sw_MT_GetMappingNameAt Get mapping name at specified index
sw_MT_ResetMappingStatus Set all mappings to inactive
sw_MT_SetMappingStatus Set mapping status to active or inactive
sw_RunAction Run the currently loaded action
sw_RunSequence Runs the sequence currently loaded
sw_SetMacroArguments Set argument string in currently loaded macro action
sw_SetSerialNumber Sets the serial number for the specified mapping of the sequence currently loaded
sw_SetUserTCK Sets the TCK frequency (in Hz)
sw_SetUserTCKMode Sets the TCK mode

 

Free Hit Counter Code