1.2.4.4 Library Interface
Console System Service library provides the following interfaces:
Functions
| Name | Description |
|---|---|
| SYS_CONSOLE_Initialize | Initializes the console instance module and opens or initializes the specific module instance to which it is associated |
| SYS_CONSOLE_Tasks | Maintains the console's state machine |
| SYS_CONSOLE_Status | Returns status of the specific instance of the Console module |
| SYS_CONSOLE_HandleGet | Returns a handle to the requested console instance |
| SYS_CONSOLE_DeviceGet | Returns the device type for a given console instance |
| SYS_CONSOLE_Read | Reads data from the console device |
| SYS_CONSOLE_Write | Writes data to the console device |
| SYS_CONSOLE_Flush | Flushes the read and write queues for the given console instance |
| SYS_CONSOLE_ReadFreeBufferCountGet | Returns the amount of free space in bytes available in the receive buffer |
| SYS_CONSOLE_ReadCountGet | Returns number of unread bytes available in the receive buffer |
| SYS_CONSOLE_WriteFreeBufferCountGet | Returns the amount of free space in bytes in the transmit buffer |
| SYS_CONSOLE_WriteCountGet | Returns the number of bytes pending for transmission in the transmit buffer |
| SYS_CONSOLE_Print | Formats and prints a message with a variable number of arguments to the console |
| SYS_CONSOLE_Message | Prints a message to the console |
Data types and constants
| Name | Type | Description |
|---|---|---|
| STDXXX_FILENO | Macros | Standard Input/Output/Error File Number Macros |
| SYS_CONSOLE_DEFAULT_INSTANCE | Macro | System Console defualt instance |
| SYS_CONSOLE_PRINT | Macro | Prints formatted message on the default console instance |
| SYS_CONSOLE_MESSAGE | Macro | Prints message on the default console instance |
| SYS_CONSOLE_STATUS | Enum | System Console Status |
| SYS_CONSOLE_DEVICE | Enum | Lists the available console devices |
| SYS_CONSOLE_HANDLE | Typedef | Handle to an instance of the console system service |
| SYS_CONSOLE_HANDLE_INVALID | Macro | Invalid console handle |