SetVCAN3Settings 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 writes configuration settings to a ValueCAN3 device.

C/C++ Declare

int _stdcall icsneoSetVCAN3Settings(int hObject, SVCAN3Settings *pSettings, int iNumBytes, int bSaveToEEPROM);

Visual Basic Declare

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


Visual Basic .NET Declare

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


C# Declare

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


Parameters

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

pSettings
    [in] The address of an allocated SVCAN3Settings  structure. 

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

bSaveToEEPROM
    [in] If set to 0, the settings changes will revert to the values stored in EEPROM when the ValueCAN3 is power-cycled. If set to 1, the values will overwrite the EEPROM settings and become persistent across power-cycles of the ValueCAN3.

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

Before using this function, the SVCAN3Settings structure must be initialized with the current neoVI settings using GetVCAN3Settings.

Examples

Visual Basic Example

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

Dim VCANReadSettings As SVCAN3Settings
Dim lNumberOfBytes As Long
Dim lResult As Integer

'//################################
'//VCANReadSettings struct is read
'//and changed as needed before
'//Setting the new values
'//################################

lResult = icsneoSetVCAN3Settings(m_hObject, VCANReadSettings , LenB(VCANReadSettings), 1)
If lResult = 0 Then
    MsgBox("Problem Sending VCAN configuration", vbOKOnly)
    Exit Sub
End If
 

C/C++ Example

SVCAN3Settings VCANReadSettings;
int iNumberOfBytes;
int iResult;

//################################
//VCANReadSettings struct is read
//and changed as needed before
//Setting the new values
//################################

iNumberOfBytes=sizeof(VCANReadSettings );
iResult = icsneoSetVCAN3Settings(m_hObject, &VCANReadSettings , iNumberOfBytes, 1);
if(iResult == 0)
{
    MessageBox::Show("Problem Sending VCAN configuration");
    return;
}

C# Example

SVCAN3Settings VCANReadSettings = new VCANReadSettings();
int iNumberOfBytes;
int iResult;

//################################
//VCANReadSettings struct is read
//and changed as needed before
//Setting the new values
//################################

iNumberOfBytes = System.Runtime.InteropServices.Marshal.SizeOf(VCANReadSettings);
iResult = icsNeoDll.icsneoSetVCAN3Settings(m_hObject, ref VCANReadSettings , iNumberOfBytes, 1);

if(iResult == 0)
{
    MessageBox.Show("Problem Sending VCAN configuration");
    return;
}

Visual Basic .NET Example

Dim VCANReadSettings As SVCAN3Settings
Dim iNumberOfBytes As Integer
Dim iResult As Integer

'//################################
'//VCANReadSettings struct is read
'//and changed as needed before
'//Setting the new values
'//################################

iNumberOfBytes = System.Runtime.InteropServices.Marshal.SizeOf(VCANReadSettings)
iResult = icsneoSetVCAN3Settings(m_hObject, VCANReadSettings , iNumberOfBytes, 1)

If iResult = 0 Then
    MsgBox("Problem Sending VCAN configuration")
    Exit Sub
End If

Last Updated : Tuesday, December 30, 2008