ScriptStop Method - neoVI API

This method stops the execution of a script that is running on a neoVI device.

C/C++ Declare

int _stdcall icsneoScriptStop(void * hObject);

Visual Basic .NET Declare

C# Declare

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

Return Values

1 if the function succeeded. 0 if it failed for any reason. GetLastAPIError must be called to obtain the specific error.

Remarks

If a script is executing on the neoVI calling this method will stop it. The script will still be present on the device and can be started again by ScriptStart The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

NEOVI_ERROR_DLL_SCRIPT_NO_SCRIPT_RUNNING = 226

Examples

C/C++ Example:

int iRetVal;
unsigned long lLastErrNum;

iRetVal = icsneoScriptStop(m_hObject);
if(iRetVal == 0)
{
    printf("Failed to Stop the script API Error\n");
}
else
{
    printf("Successfully stopped the script\n");
}

C# Example:

Visual Basic .NET Example: