GetFireSettings 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 neoVI Fire device.

C/C++ Declare

int _stdcall icsneoGetFireSettings(int hObject, SFireSettings *pSettings, int iNumBytes);

Visual Basic Declare

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


Visual Basic .NET Declare

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


C# Declare

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


Parameters

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

pSettings
    [out] Pointer to an SFireSettings structure.

iNumBytes
    [in] This value is always the size, in bytes, of the SFireSettings 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 SFireSettings structure and write the settings back to the neoVI Fire using SetFireSettings. 

Examples

Visual Basic Example

Dim FireReadSettings As SFireSettings
Dim lNumberOfBytes As Long
Dim lResult As Long

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


C/C++ Example

SFireSettings FireReadSettings;
int iNumberOfBytes;
int iResult;

//Get the settings
iNumberOfBytes=sizeof(SFireSettings);
iResult = icsneoGetFireSettings(m_hObject, &FireReadSettings, iNumberOfBytes);
if(iResult == 0)
{
    MessageBox::Show("Problem reading FIRE configuration");
    return;
}


C# Example

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

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


Visual Basic .NET Example

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

Dim FireReadSettings As SFireSettings
Dim iNumberOfBytes As Integer
Dim iResult As Integer

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

Last Updated : Wednesday, December 17, 2008