NI-HSDIO C Function Reference

niHSDIO_ConfigureScriptToGenerate

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus = niHSDIO_ConfigureScriptToGenerate ( ViSession vi, ViConstString scriptName);

Purpose

Sets the script to be generated upon a call to the niHSDIO_Initiate function when the NIHSDIO_ATTR_GENERATION_MODE attribute is set to NIHSDIO_VAL_SCRIPTED. If multiple scripts load when niHSDIO_Initiate is called, then one script must be designated as the script to generate or you receive an error. This function need only be called if multiple scripts are present in onboard memory (refer to the NIHSDIO_ATTR_SCRIPT_TO_GENERATE attribute for more information).

Related topics:

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
Script Name ViConstString Specifies a string containing a syntactically correct script that is written to the onboard memory.

Return Value

Name Type Description
Status ViStatus

Reports the status of this operation. To obtain a text description of the status code, call the niHSDIO_error_message function. To obtain additional information concerning the error condition, use the niHSDIO_GetError and niHSDIO_ClearError functions.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience