GetFIRE2Settings Method - intrepidcs API

C/C++ declare - VB.NET declare - C# declare - Parameters - Return Values - Remarks - C/C++ example - VB.NET example - C# example

This method reads the configuration settings from a neoVI FIRE 2 device.

C/C++ Declare

int _stdcall icsneoGetFIRE2Settings(void * hObject, SFIRE2Settings *pSettings, int iNumBytes);

Visual Basic .NET Declare

Public Declare Function icsneoGetFIRE2Settings Lib “icsneo40.dll” (ByVal hObject As IntPtr, ByRef pSettings As SFIRE2Settings , ByVal iNumBytes As Int32) As Int32

C# Declare

[DllImport(“icsneo40.dll”)] public static extern Int32 icsneoGetFIRE2Settings(IntPtr hObject, ref SFIRE2Settings pSettings, Int32 iNumBytes);

Parameters

hObject

[in] Specifies the driver object created by OpenNeoDevice.

pSettings

[out] Pointer to a SFIRE2Settings structure.

iNumBytes

[in] This value is always the size, in bytes, of the SFIRE2Settings 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 SFIRE2Settings structure and write the settings back to the neoVI FIRE 2 using SetFIRE2Settings.

---

Examples

C/C++ Example

SFIRE2Settings Fire2ReadSettings;
int iNumberOfBytes;
int iResult;

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

C# Example

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

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

Visual Basic .NET Example

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

Dim Fire2ReadSettings As SFIRE2Settings
Dim iNumberOfBytes As Integer
Dim iResult As Integer

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