Public Member Functions
|int32||open (void *arg)|
|int32||read (uint8 *buffer, const int32 count)|
|int32||write (uint8 *buffer, const int32 count)|
|int32||ioCtl (uint32 cmd, void *arg)|
|int32||seek (uint32 offset, SeekWhenceEnum whence)|
constructors, destructors ConsoleDevice Constructor.
Writes all internally buffered data onto the device and clears the send and receive buffers.
Universal method that may be used to configure the device and implement functionality not provided by the interface. The meaning of the different commands executed by this function is entirely device dependent (cmd 1 on device A may be something completely different on device B).
|cmd||A command that specifies the function to be executed by the method|
|arg||A pointer to an argument passed to the function to be executed|
|int32 ApparatusFramework::ConsoleDevice::open||(||void *||arg||)||
Interface Opens a character device. First method to be called after the instantiation. If this method returns successfully, the device is ready to use.
|arg||A void pointer that can be used for whatever one one choses (default = null).|
Reads a specified number of characters from the device into a provided buffer. This read method for a device is usually implemented blocking (blocks the calling client).
|buffer||Pointer to a character buffer. Its the buffer that read will use to fill in the fetched data.|
|count||Number of characters to be read (does not necessarily correspond with the return value).|
Allows to jump onto a certain position. Seek uses an offset that specifies the location from a certain starting point. (e.g. used in files to write onto a specified position). seek may also be used to find the size of a file (return value of seek(0, SEEK_END)).
|offset||A number that specifies the amount of chars the wanted position is away from a given starting position (whence defines that).|
|whence||Defines the starting position or how the given index should be interpreted. See SeekWhenceEnum|
Writes a specified number of characters from a buffer onto the device.
|buffer||Pointer to a character buffer. Its the buffer that write takes as data source.|
|count||Number of characters to be taken out of the buffer onto the device.|
© 2004-2010 bbv Software Services AG / Apparatus Services