Public Member Functions

INex Class Reference

Interface representing main Nex object. More...

#include <INex.h>

List of all members.

Public Member Functions

virtual NexErrorCode getDeviceCount (NexDeviceType type, int *baseID, int *countReturn)=0
 Gets the number of devices attached to the system since last device detection of the given type.
virtual NexErrorCode getDeviceInfo (int ID, void *infoReturn)=0
 Gets information about the device attached to the system since last device detection.
virtual NexErrorCode createDevice (int ID, INexDevice **deviceReturn)=0
 Creates a device associated with the given ID.
virtual NexErrorCode redetectDevices ()=0
 Attempts to redetect devices.
virtual void release ()=0
 Releases the object and all objects created by it.

Detailed Description

Interface representing main Nex object.


Member Function Documentation

virtual NexErrorCode INex::createDevice ( int  ID,
INexDevice **  deviceReturn 
) [pure virtual]

Creates a device associated with the given ID.

Parameters:
[in]IDThe ID of the device.
[out]deviceReturnAddress of pointer to receive newly created device
Returns:
Standard error codes, see NexErrorCode
virtual NexErrorCode INex::getDeviceCount ( NexDeviceType  type,
int *  baseID,
int *  countReturn 
) [pure virtual]

Gets the number of devices attached to the system since last device detection of the given type.

The range of IDs is always contiguous, [ baseId, baseId + countReturn - 1]

Parameters:
[in]typeThe type of device to determine the count of.
[out]baseIDThe base ID number starting for this device type
[out]countReturnThe number of devices of this type.
Returns:
Standard error codes, see NexErrorCode
virtual NexErrorCode INex::getDeviceInfo ( int  ID,
void *  infoReturn 
) [pure virtual]

Gets information about the device attached to the system since last device detection.

Parameters:
[in]IDThe ID of the device
[out]infoReturnThe structure to receive information about the device. Use NexMouseInfo or NexKeyboardInfo
Returns:
Standard error codes, see NexErrorCode
virtual NexErrorCode INex::redetectDevices (  ) [pure virtual]

Attempts to redetect devices.

Returns:
Standard error codes, see NexErrorCode
virtual void INex::release (  ) [pure virtual]

Releases the object and all objects created by it.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations Enumerator Defines