Unit Devices

Return to Unit Reference

Description

---

To be documented

Constants

---

To be documented

Type definitions

---

To be documented

Public variables

---

To be documented

Function declarations

---

Device functions

function function DeviceCreate:PDevice;

Description: Create a new Device entry

Return	Pointer to new Device entry or nil if device could not be created

function DeviceCreateEx(Size:LongWord):PDevice;

Description: Create a new Device entry

Size	Size in bytes to allocate for new device (Including the device entry)
Return	Pointer to new Device entry or nil if device could not be created

function DeviceDestroy(Device:PDevice):LongWord;

Description: Destroy an existing Device entry

Note	To be documented

function DeviceGetName(Device:PDevice):String;

Description: Get the name of the supplied Device

Note	To be documented

function DeviceSetName(Device:PDevice; const Name:String):LongWord;

Description: Set the name of the supplied Device

Note	To be documented

function DeviceGetDescription(Device:PDevice):String;

Description: Get the description of the supplied Device

Note	To be documented

function DeviceSetDescription(Device:PDevice; const Description:String):LongWord;

Description: Set the description of the supplied Device

Note	To be documented

function DeviceRegister(Device:PDevice):LongWord;

Description: Register a new Device in the Device table

Note	To be documented

function DeviceDeregister(Device:PDevice):LongWord;

Description: Deregister a Device from the Device table

Note	To be documented

function DeviceFind(DeviceClass,DeviceId:LongWord):PDevice;

Description: To be documented

Note	To be documented

function DeviceFindByName(const Name:String):PDevice;

Description: To be documented

Note	To be documented

function DeviceFindByDescription(const Description:String):PDevice;

Description: To be documented

Note	To be documented

function DeviceEnumerate(DeviceClass:LongWord; Callback:TDeviceEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function DeviceNotification(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

function NotifierAllocate(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer; Notification,Flags:LongWord):PNotifier;

Description: Create and Register a new Notifier entry in the Notifier table

Note	To be documented

function NotifierRelease(Notifier:PNotifier):LongWord;

Description: Deregister and Destroy a Notifier from the Notifier table

Note	To be documented

function NotifierFind(Device:PDevice; DeviceClass:LongWord; Callback:TDeviceNotification; Data:Pointer):PNotifier;

Description: To be documented

Note	To be documented

function NotifierNotify(Device:PDevice; Notification:LongWord):LongWord;

Description: To be documented

Note	To be documented

Driver functions

function DriverCreate:PDriver;

Description: Create a new Driver entry

Return	Pointer to new Driver entry or nil if driver could not be created

function DriverCreateEx(Size:LongWord):PDriver;

Description: Create a new Driver entry

Size	Size in bytes to allocate for new driver (Including the driver entry)
Return	Pointer to new Driver entry or nil if driver could not be created

function DriverDestroy(Driver:PDriver):LongWord;

Description: Destroy an existing Driver entry

Note	To be documented

function DriverGetName(Driver:PDriver):String;

Description: Get the name of the supplied Driver

Note	To be documented

function DriverSetName(Driver:PDriver; const Name:String):LongWord;

Description: Set the name of the supplied Driver

Note	To be documented

function DriverRegister(Driver:PDriver):LongWord;

Description: Register a new Driver in the Driver table

Note	To be documented

function DriverDeregister(Driver:PDriver):LongWord;

Description: Deregister a Driver from the Driver table

Note	To be documented

function DriverFind(DriverClass,DriverId:LongWord):PDriver;

Description: To be documented

Note	To be documented

function DriverFindByName(const Name:String):PDriver;

Description: To be documented

Note	To be documented

function DriverEnumerate(DriverClass:LongWord; Callback:TDriverEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

Clock device functions

function ClockDeviceStart(Clock:PClockDevice):LongWord;

Description: To be documented

Note	To be documented

function ClockDeviceStop(Clock:PClockDevice):LongWord;

Description: To be documented

Note	To be documented

function ClockDeviceRead(Clock:PClockDevice):LongWord;

Description: To be documented

Note	To be documented

function ClockDeviceRead64(Clock:PClockDevice):Int64;

Description: To be documented

Note	To be documented

function ClockDeviceGetRate(Clock:PClockDevice):LongWord;

Description: To be documented

Note	To be documented

function ClockDeviceCreate:PClockDevice;

Description: Create a new Clock entry

Return	Pointer to new Clock entry or nil if Clock could not be created

function ClockDeviceCreateEx(Size:LongWord):PClockDevice;

Description: Create a new Clock entry

Size	Size in bytes to allocate for new Clock (Including the Clock entry)
Return	Pointer to new Clock entry or nil if Clock could not be created

function ClockDeviceDestroy(Clock:PClockDevice):LongWord;

Description: Destroy an existing Clock entry

Note	To be documented

function ClockDeviceRegister(Clock:PClockDevice):LongWord;

Description: Register a new Clock in the Clock table

Note	To be documented

function ClockDeviceDeregister(Clock:PClockDevice):LongWord;

Description: Deregister a Clock from the Clock table

Note	To be documented

function ClockDeviceFind(ClockId:LongWord):PClockDevice;

Description: To be documented

Note	To be documented

function ClockDeviceFindByName(const Name:String):PClockDevice; inline;

Description: To be documented

Note	To be documented

function ClockDeviceFindByDescription(const Description:String):PClockDevice; inline;

Description: To be documented

Note	To be documented

function ClockDeviceEnumerate(Callback:TClockEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function ClockDeviceNotification(Clock:PClockDevice; Callback:TClockNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

Timer device functions

function TimerDeviceStart(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceStop(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceRead(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceRead64(Timer:PTimerDevice):Int64;

Description: To be documented

Note	To be documented

function TimerDeviceWait(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceEvent(Timer:PTimerDevice; Flags:LongWord; Callback:TTimerCallback; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceGetRate(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceSetRate(Timer:PTimerDevice; Rate:LongWord):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceGetInterval(Timer:PTimerDevice):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceSetInterval(Timer:PTimerDevice; Interval:LongWord):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceProperties(Timer:PTimerDevice; Properties:PTimerProperties):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceCreate:PTimerDevice;

Description: Create a new Timer entry

Return	Pointer to new Timer entry or nil if Timer could not be created

function TimerDeviceCreateEx(Size:LongWord):PTimerDevice;

Description: Create a new Timer entry

Size	Size in bytes to allocate for new Timer (Including the Timer entry)
Return	Pointer to new Timer entry or nil if Timer could not be created

function TimerDeviceDestroy(Timer:PTimerDevice):LongWord;

Description: Destroy an existing Timer entry

Note	To be documented

function TimerDeviceRegister(Timer:PTimerDevice):LongWord;

Description: Register a new Timer in the Timer table

Note	To be documented

function TimerDeviceDeregister(Timer:PTimerDevice):LongWord;

Description: Deregister a Timer from the Timer table

Note	To be documented

function TimerDeviceFind(TimerId:LongWord):PTimerDevice;

Description: To be documented

Note	To be documented

function TimerDeviceFindByName(const Name:String):PTimerDevice; inline;

Description: To be documented

Note	To be documented

function TimerDeviceFindByDescription(const Description:String):PTimerDevice; inline;

Description: To be documented

Note	To be documented

function TimerDeviceEnumerate(Callback:TTimerEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function TimerDeviceNotification(Timer:PTimerDevice; Callback:TTimerNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

Random device functions

function RandomDeviceStart(Random:PRandomDevice):LongWord;

Description: To be documented

Note	To be documented

function RandomDeviceStop(Random:PRandomDevice):LongWord;

Description: To be documented

Note	To be documented

function RandomDeviceSeed(Random:PRandomDevice; Seed:LongWord):LongWord;

Description: To be documented

Note	To be documented

function RandomDeviceReadByte(Random:PRandomDevice):Byte;

Description: To be documented

Note	To be documented

function RandomDeviceReadWord(Random:PRandomDevice):Word;

Description: To be documented

Note	To be documented

function RandomDeviceReadLongWord(Random:PRandomDevice):LongWord;

Description: To be documented

Note	To be documented

function RandomDeviceReadQuadWord(Random:PRandomDevice):Int64;

Description: To be documented

Note	To be documented

function RandomDeviceReadExtended(Random:PRandomDevice):Extended;

Description: To be documented

Note	To be documented

function RandomDeviceCreate:PRandomDevice;

Description: Create a new Random entry

Return	Pointer to new Random entry or nil if Random could not be created

function RandomDeviceCreateEx(Size:LongWord):PRandomDevice;

Description: Create a new Random entry

Size	Size in bytes to allocate for new Random (Including the Random entry)
Return	Pointer to new Random entry or nil if Random could not be created

function RandomDeviceDestroy(Random:PRandomDevice):LongWord;

Description: Destroy an existing Random entry

Note	To be documented

function RandomDeviceRegister(Random:PRandomDevice):LongWord;

Description: Register a new Random in the Random table

Note	To be documented

function RandomDeviceDeregister(Random:PRandomDevice):LongWord;

Description: Deregister a Random from the Random table

Note	To be documented

function RandomDeviceFind(RandomId:LongWord):PRandomDevice;

Description: To be documented

Note	To be documented

function RandomDeviceFindByName(const Name:String):PRandomDevice; inline;

Description: To be documented

Note	To be documented

function RandomDeviceFindByDescription(const Description:String):PRandomDevice; inline;

Description: To be documented

Note	To be documented

function RandomDeviceEnumerate(Callback:TRandomEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function RandomDeviceNotification(Random:PRandomDevice; Callback:TRandomNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

Mailbox device functions

function MailboxDeviceStart(Mailbox:PMailboxDevice):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceStop(Mailbox:PMailboxDevice):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceReceive(Mailbox:PMailboxDevice; Channel:LongWord):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceSend(Mailbox:PMailboxDevice; Channel,Data:LongWord):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceCall(Mailbox:PMailboxDevice; Channel,Data:LongWord; var Response:LongWord):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceGetTimeout(Mailbox:PMailboxDevice):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceSetTimeout(Mailbox:PMailboxDevice; Timeout:LongWord):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceCreate:PMailboxDevice;

Description: Create a new Mailbox entry

Return	Pointer to new Mailbox entry or nil if Mailbox could not be created

function MailboxDeviceCreateEx(Size:LongWord):PMailboxDevice;

Description: Create a new Mailbox entry

Size	Size in bytes to allocate for new Mailbox (Including the Mailbox entry)
Return	Pointer to new Mailbox entry or nil if Mailbox could not be created

function MailboxDeviceDestroy(Mailbox:PMailboxDevice):LongWord;

Description: Destroy an existing Mailbox entry

Note	To be documented

function MailboxDeviceRegister(Mailbox:PMailboxDevice):LongWord;

Description: Register a new Mailbox in the Mailbox table

Note	To be documented

function MailboxDeviceDeregister(Mailbox:PMailboxDevice):LongWord;

Description: Deregister a Mailbox from the Mailbox table

Note	To be documented

function MailboxDeviceFind(MailboxId:LongWord):PMailboxDevice;

Description: To be documented

Note	To be documented

function MailboxDeviceFindByName(const Name:String):PMailboxDevice; inline;

Description: To be documented

Note	To be documented

function MailboxDeviceFindByDescription(const Description:String):PMailboxDevice; inline;

Description: To be documented

Note	To be documented

function MailboxDeviceEnumerate(Callback:TMailboxEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function MailboxDeviceNotification(Mailbox:PMailboxDevice; Callback:TMailboxNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

Watchdog device functions

function WatchdogDeviceStart(Watchdog:PWatchdogDevice):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceStop(Watchdog:PWatchdogDevice):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceRefresh(Watchdog:PWatchdogDevice):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceGetRemain(Watchdog:PWatchdogDevice):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceGetTimeout(Watchdog:PWatchdogDevice):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceSetTimeout(Watchdog:PWatchdogDevice; Timeout:LongWord):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceCreate:PWatchdogDevice;

Description: Create a new Watchdog entry

Return	Pointer to new Watchdog entry or nil if Watchdog could not be created

function WatchdogDeviceCreateEx(Size:LongWord):PWatchdogDevice;

Description: Create a new Watchdog entry

Size	Size in bytes to allocate for new Watchdog (Including the Watchdog entry)
Return	Pointer to new Watchdog entry or nil if Watchdog could not be created

function WatchdogDeviceDestroy(Watchdog:PWatchdogDevice):LongWord;

Description: Destroy an existing Watchdog entry

Note	To be documented

function WatchdogDeviceRegister(Watchdog:PWatchdogDevice):LongWord;

Description: Register a new Watchdog in the Watchdog table

Note	To be documented

function WatchdogDeviceDeregister(Watchdog:PWatchdogDevice):LongWord;

Description: Deregister a Watchdog from the Watchdog table

Note	To be documented

function WatchdogDeviceFind(WatchdogId:LongWord):PWatchdogDevice;

Description: To be documented

Note	To be documented

function WatchdogDeviceFindByName(const Name:String):PWatchdogDevice; inline;

Description: To be documented

Note	To be documented

function WatchdogDeviceFindByDescription(const Description:String):PWatchdogDevice; inline;

Description: To be documented

Note	To be documented

function WatchdogDeviceEnumerate(Callback:TWatchdogEnumerate; Data:Pointer):LongWord;

Description: To be documented

Note	To be documented

function WatchdogDeviceNotification(Watchdog:PWatchdogDevice; Callback:TWatchdogNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;

Description: To be documented

Note	To be documented

RTL clock functions

function SysClockRead:LongWord;

Description: To be documented

Note	To be documented

function SysClockRead64:Int64;

Description: To be documented

Note	To be documented

RTL timer (counter) functions

function SysTimerAvailable:Boolean;

Description: Check if a timer device is available

Note	To be documented

function SysTimerRead:LongWord;

Description: Read the current value of the default counter

Return	The 32 bit current value of the current or 0 on failure

function SysTimerRead64:Int64;

Description: Read the current value of the default counter

Return	The 64 bit current value of the current or 0 on failure

function SysTimerWait:LongWord;

Description: Wait for the current interval to expire on the default counter

Return	ERROR_SUCCESS if the interval expired or another error code on failure

function SysTimerEvent(Callback:TTimerCallback; Data:Pointer):LongWord;

Description: Schedule a function to be called when the current interval expires on the default counter

Callback	The function to be called when the interval expires
Data	A pointer to be pass to the function when the interval expires (Optional)
Return	ERROR_SUCCESS if the callback was scheduled successfully or another error code on failure

function SysTimerGetRate:LongWord;

Description: Get the current clock rate in Hz of the default counter

Return	The current clock rate in Hz or 0 on failure

function SysTimerSetRate(Rate:LongWord):LongWord;

Description: Set the current clock rate in Hz of the default counter

Rate	The clock rate in Hz to set
Return	ERROR_SUCCESS if the clock rate was set or another error code on failure

function SysTimerGetInterval:LongWord;

Description: Get the current interval in milliseconds of the default counter

Return	The current interval in milliseconds or 0 on failure (or not set)

function SysTimerSetInterval(Interval:LongWord):LongWord;

Description: Set the current interval in milliseconds of the default counter

Interval	The interval in milliseconds to set
Return	ERROR_SUCCESS if the interval was set or another error code on failure

Return to Unit Reference