closeport-method-intrepidcs-api.md

cover	coverY
../../.gitbook/assets/new-cover-image.png	0

ClosePort Method - IntrepidCS API

This method closes the communication link with the neoVI hardware.

{% tabs %} {% tab title="C/C++ Declare" %}

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

{% endtab %}

{% tab title="Visual Basic .NET Declare" %}

Public Declare Function icsneoClosePort Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pNumberOfErrors As Int32) As Int32

{% endtab %}

{% tab title="C# Declare" %}

[DllImport(“icsneo40.dll”)] public static extern Int32 icsneoClosePort(IntPtr hObject, ref Int32 pNumberOfErrors);

{% endtab %} {% endtabs %}

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

{% tabs %} {% tab title="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);

{% endtab %}

{% tab title="C# Example" %}

//Declared at form level and previously open with a call to OpenNeoDevice
IntPtr m_hObject; //handle for device,

int iResult;
int iNumberOfErrors = 0;

//close the port
iResult = icsNeoDll.icsneoClosePort(m_hObject, ref iNumberOfErrors);
if (iResult == 1)
{
    MessageBox.Show("Port Closed OK!");
}
else
{
    MessageBox.Show("Problem ClosingPort");
}
m_bPortOpen = false;

{% endtab %}

{% tab title="Visual Basic .NET Example" %}

Private m_hObject As IntPtr '// Declared at form level and previously open with a call to OpenNeoDevice

Dim iResult As Integer
Dim iNumberOfErrors As Integer

'//close the port
iResult = icsneoClosePort(m_hObject, iNumberOfErrors)
If CBool(iResult) Then
    MsgBox("Port Closed OK!")
Else
    MsgBox("Problem Closing Port")
End If

{% endtab %} {% endtabs %}