ClosePort Method - neoVI API

This method closes the communication link with the neoVI hardware.

C/C++ Declare

int _stdcall icsneoClosePort(void * hObject, int * pNumberOfErrors);

Visual Basic .NET Declare

C# Declare

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pNumberOfErrors

[out] Specifies the number of errors in the neoVI DLL error queue. You can read out the errors by calling the GetErrorMessages method.

Return Values

If the port has been closed successfully the return value will be 1. Otherwise, it will return zero. It will also return zero if the port is already closed.

Remarks

Must be called once for each successful call to OpenNeoDevice or memory and resource leaks will occur.

Examples

C/C++ Example

int lNumberOfErrors;    // used to get the number of errors
int iResult;

// Close Communication
iResult = icsneoClosePort(hObject, &iNumberOfErrors);
// Test the Result
if (iResult== 0)
    MessageBox(hWnd,TEXT("Problem Closing Port"),TEXT("neoVI Example"),0);
else
    MessageBox(hWnd,TEXT("Port Closed Successfully"),TEXT("neoVI Example"),0);

C# Example

Visual Basic .NET Example