beautypg.com

Chapter 2 reference, General types, Shconnection_t structure – Bird Technologies SignalHawk User Manual

Page 15: Shdevices_t structure, Shdllproperties_t structure, Sherrordata structure, Shconnection_t structure members, Shdevices_t structure members, Shdllproperties_t structure members

background image

3

Chapter 2

Reference

General Types

shConnection_t Structure

This structure is used to represent a connection that has been estab-

lished with a particular Signal Hawk RF Module. The API assigns the

handle. User applications must use a valid shConnection_t object to

communicate with specific PC Hawk devices.

shConnection_t Structure Members

shDevices_t Structure

This structure contains information about connected Signal Hawk devices.

The API assigns the fields of the structure. The API will populate informa-

tion for up to MAX_DEVICES PC Hawks. MAX_DEVICES is currently

256. The structure is not needed after a connection is established.

shDevices_t Structure Members

shDllProperties_t Structure

This structure contains information about the PC Hawk API revision.

shDllProperties_t Structure Members

shErrorData Structure

This structure contains information about the most recent error
encountered by the API.

Device

A handle used by the API to reference a
specific PC Hawk inside the API.

NumDevices

The number of PC Hawks found
connected to the USB.

SerialNumber[MAX_DEVICES][]

Array of character strings containing the
serial numbers for the detected PC
Hawk devices.

BirdShVersion[256]

A character string indicating the
revision level of the API.