beautypg.com

Ocean Optics NeoFox Engineering Note User Manual

Page 8

background image

NeoFox Communication Interfaces

8 013-20000-010-04-201211


Parameters

int

hDevice

Handle to an open NeoFox device

int

ParamType

Unique code for the parameter which is to be read.

LPTSTR

szText

A character buffer (char*). Be sure to pass this parameter a pointer
to an initialized buffer of at least 50 bytes.


Return Value

The function returns an int that represents the value that has been queried from the device. In some cases, it will
also populate the szText buffer with a textual representation of the integer value.

Remarks

Although this function returns a 4 byte integer value, it should also be used to query the values of short and char
type parameters. It is also important to note that although the function will sometimes populate the szText
buffer, users are advised not to use this value unless the szText parameter is explicitly discussed in a particular
variable’s information (from the variable table at the end of this document).

float DeviceGetParameterFloat(int hDevice, int ParamType, LPTSTR szText)

Description

Reads a floating point type parameter from the NeoFox device.


Parameters

int

hDevice

Handle to an open NeoFox device

int

ParamType

Unique code for the parameter which is to be read.

LPTSTR

szText

A character buffer (char*). Be sure to pass this parameter a pointer to an
initialized buffer of at least 50 bytes.


Return Value

The function returns a float that represents the value that has been queried from the device. In some cases, it will
also populate the szText buffer with a textual representation of the integer value.


Remarks

Although this function returns a 4 byte integer value, it should also be used to query the values of short and char
type parameters. It is also important to note that although the function will sometimes populate the szText
buffer, users are advised not to depend on this information, which is not explicitly supported.


int ApplicationStartup(int hInstance)

Description

This function starts a thread for the DLL.

Parameters

int

hInstance

Pass NULL to this parameter.