GetVCAN3Settings Method - intrepidcs API
C/C++ declare - VB declare - VB.NET declare - C# declare - Parameters - Return Values - Remarks - C/C++ example - VB example - VB.NET example - C# example

This method reads the configuration settings from a ValueCAN3 device.

C/C++ Declare

int _stdcall icsneoGetVCAN3Settings(int hObject, SVCAN3Settings *pSettings, int *iNumBytes);

Visual Basic Declare

Public Declare Function icsneoGetVCAN3Settings Lib "icsneo40.dll" (ByVal hObject As Long, ByRef pSettings As SVCAN3Settings, ByVal iNumBytes As Long) As Long


Visual Basic .NET Declare

Public Declare Function icsneoGetVCAN3Settings Lib "icsneo40.dll" (ByVal hObject As Int32, ByRef pSettings As SVCAN3Settings, ByVal iNumBytes As Int32) As Int32


C# Declare

[DllImport("icsneo40.dll")]
public static extern Int32 icsneoGetVCAN3Settings(Int32 hObject, ref SVCAN3Settings pSettings, Int32 iNumBytes);


Parameters

hObject
    [in] Specifies the driver object created by OpenNeoDevice.

pSettings
    [out] Pointer to a SVCAN3Settings structure.

iNumBytes
    [in] This value is always the size, in bytes, of the SVCAN3Settings structure.

Return Values

Returns 1 if successful, 0 if an error occurred. GetLastAPIError must be called to obtain the specific error. The errors that can be generated by this function are:

NEOVI_ERROR_DLL_NEOVI_NO_RESPONSE = 75

Remarks

After getting the current settings, you may change the parameters defined in the SVCAN3Settings structure and write the settings back to the ValueCAN3 using SetVCAN3Settings. 

Examples

Visual Basic Example

Dim VcanReadSettings As SVCAN3Settings
Dim lNumberOfBytes As Long
Dim lResult As Long

'//Get the setting
lResult = icsneoGetVCAN3Settings(m_hObject, VcanReadSettings , LenB(VcanReadSettings ))
If lResult = 0 Then
    MsgBox("Problem reading FIRE configuration", vbOKOnly)
    Exit Sub
End If


C/C++ Example

SVCAN3Settings VcanReadSettings;
int iNumberOfBytes;
int iResult;

//Get the settings
iNumberOfBytes=sizeof(VcanReadSettings );
iResult = icsneoGetVCAN3Settings(m_hObject, &VcanReadSettings , iNumberOfBytes);
if(iResult == 0)
{
    MessageBox::Show("Problem reading VCAN configuration");
    return;
}


C# Example

//Declared at form level and previously open with a call to OpenNeoDevice
int m_hObject; //handle for device,
SVCAN3Settings VcanReadSettings = new SVCAN3Settings();
int iNumberOfBytes;
int iResult;

//Get the settings
iNumberOfBytes = System.Runtime.InteropServices.Marshal.SizeOf(VcanReadSettings);
iResult = icsNeoDll.icsneoGetVCAN3Settings(m_hObject,ref VcanReadSettings , iNumberOfBytes);
if (iResult == 0)
{
    MessageBox.Show("Problem reading VCAN configuration");
    return;
}


Visual Basic .NET Example

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

Dim VcanReadSettings As SVCAN3Settings
Dim iNumberOfBytes As Integer
Dim iResult As Integer

'//Get the settings
iNumberOfBytes = System.Runtime.InteropServices.Marshal.SizeOf(VcanReadSettings)
iResult = icsneoGetVCAN3Settings(m_hObject, VcanReadSettings , iNumberOfBytes)
If iResult = 0 Then
    MsgBox("Problem reading VCAN configuration")
    Exit Sub
End If

Last Updated : Wednesday, December 17, 2008