Phidget Constants

Various constants used throughout the library. More...

Phidget States
Returned by getStatus() functions
#define	PHIDGET_ATTACHED   0x1
	Phidget attached.
#define	PHIDGET_NOTATTACHED   0x0
	Phidget not attached.
Phidget Error Codes
Returned by all C API calls
#define	PHIDGET_ERROR_CODE_COUNT   20
	Function completed successfully.
#define	EPHIDGET_OK   0
	Function completed successfully.
#define	EPHIDGET_NOTFOUND   1
	Phidget not found.
#define	EPHIDGET_NOMEMORY   2
	No memory.
#define	EPHIDGET_UNEXPECTED   3
	Unexpected.
#define	EPHIDGET_INVALIDARG   4
	Invalid argument.
#define	EPHIDGET_NOTATTACHED   5
	Phidget not attached.
#define	EPHIDGET_INTERRUPTED   6
	Interrupted.
#define	EPHIDGET_INVALID   7
	Invalid error code.
#define	EPHIDGET_NETWORK   8
	Network.
#define	EPHIDGET_UNKNOWNVAL   9
	Value unknown.
#define	EPHIDGET_BADPASSWORD   10
	Authorization exception.
#define	EPHIDGET_UNSUPPORTED   11
	Unsupported.
#define	EPHIDGET_DUPLICATE   12
	Duplicate request.
#define	EPHIDGET_TIMEOUT   13
	Timeout.
#define	EPHIDGET_OUTOFBOUNDS   14
	Out of bounds.
#define	EPHIDGET_EVENT   15
	Event.
#define	EPHIDGET_NETWORK_NOTCONNECTED   16
	Network not connected.
#define	EPHIDGET_WRONGDEVICE   17
	Wrong device.
#define	EPHIDGET_CLOSED   18
	Phidget Closed.
#define	EPHIDGET_BADVERSION   19
	Version Mismatch.
Phidget Unknown Constants
Data values will be set to these constants when a call fails with EPHIDGET_UNKNOWNVAL.
#define	PUNK_BOOL   0x02
	Unknown Boolean (unsigned char).
#define	PUNK_SHRT   0x7FFF
	Unknown Short (16-bit).
#define	PUNK_INT   0x7FFFFFFF
	Unknown Integer (32-bit).
#define	PUNK_INT64   0x7FFFFFFFFFFFFFFFLL
	Unknown Integer (64-bit).
#define	PUNK_DBL   1e300
	Unknown Double.
#define	PUNK_FLT   1e30
	Unknown Float.
Defines
#define	PFALSE   0x00
	False.
#define	PTRUE   0x01
	True.

---

Detailed Description

Various constants used throughout the library.

---

Define Documentation

#define PHIDGET_ERROR_CODE_COUNT   20

Function completed successfully.

Definition at line 422 of file phidget21.h.

#define EPHIDGET_OK   0

Function completed successfully.

Definition at line 423 of file phidget21.h.

#define EPHIDGET_NOTFOUND   1

Phidget not found.

"A Phidget matching the type and or serial number could not be found." This code is not currently used.

Definition at line 424 of file phidget21.h.

#define EPHIDGET_NOMEMORY   2

No memory.

"Memory could not be allocated."

Definition at line 425 of file phidget21.h.

#define EPHIDGET_UNEXPECTED   3

Unexpected.

"Unexpected Error. Contact Phidgets Inc. for support."

Definition at line 426 of file phidget21.h.

#define EPHIDGET_INVALIDARG   4

Invalid argument.

"Invalid argument passed to function."

Definition at line 427 of file phidget21.h.

#define EPHIDGET_NOTATTACHED   5

Phidget not attached.

"Phidget not physically attached."

Definition at line 428 of file phidget21.h.

#define EPHIDGET_INTERRUPTED   6

Interrupted.

"Read/Write operation was interrupted." This code is not currently used.

Definition at line 429 of file phidget21.h.

#define EPHIDGET_INVALID   7

Invalid error code.

"The Error Code is not defined."

Definition at line 430 of file phidget21.h.

#define EPHIDGET_NETWORK   8

Network.

"Network Error."

Definition at line 431 of file phidget21.h.

#define EPHIDGET_UNKNOWNVAL   9

Value unknown.

"Value is Unknown (State not yet received from device, or not yet set by user)."

Definition at line 432 of file phidget21.h.

#define EPHIDGET_BADPASSWORD   10

Authorization exception.

"Authorization Failed."

Definition at line 433 of file phidget21.h.

#define EPHIDGET_UNSUPPORTED   11

Unsupported.

"Not Supported."

Definition at line 434 of file phidget21.h.

#define EPHIDGET_DUPLICATE   12

Duplicate request.

"Duplicated request."

Definition at line 435 of file phidget21.h.

#define EPHIDGET_TIMEOUT   13

Timeout.

"Given timeout has been exceeded."

Definition at line 436 of file phidget21.h.

#define EPHIDGET_OUTOFBOUNDS   14

Out of bounds.

"Index out of Bounds."

Definition at line 437 of file phidget21.h.

#define EPHIDGET_EVENT   15

Event.

"A non-null error code was returned from an event handler." This code is not currently used.

Definition at line 438 of file phidget21.h.

#define EPHIDGET_NETWORK_NOTCONNECTED   16

Network not connected.

"A connection to the server does not exist."

Definition at line 439 of file phidget21.h.

#define EPHIDGET_WRONGDEVICE   17

Wrong device.

"Function is not applicable for this device."

Definition at line 440 of file phidget21.h.

#define EPHIDGET_CLOSED   18

Phidget Closed.

"Phidget handle was closed."

Definition at line 441 of file phidget21.h.

#define EPHIDGET_BADVERSION   19

Version Mismatch.

"Webservice and Client protocol versions don't match. Update to newest release."

Definition at line 442 of file phidget21.h.

#define PFALSE   0x00

False.

Used for boolean values.

Definition at line 457 of file phidget21.h.

#define PTRUE   0x01

True.

Used for boolean values.

Definition at line 458 of file phidget21.h.