1.2.4.4.5 SYS_CONSOLE_DeviceGet Function

C

SYS_CONSOLE_DEVICE SYS_CONSOLE_DeviceGet( const SYS_CONSOLE_HANDLE handle)

Summary

Returns the device type for a given console instance

Description

This function returns the device type supported by the given console instance

Preconditions

The SYS_CONSOLE_Initialize function should have been called before calling this function.

Parameters

ParamDescription
handleA valid handle to the console instance

Returns

SYS_CONSOLE_DEVICE - Returns console device type. Returns SYS_CONSOLE_DEV_MAX in case of an error.

Example

SYS_CONSOLE_HANDLE myConsoleHandle;
SYS_CONSOLE_DEVICE myConsoleDevType

// myConsoleHandle is assumed to be a valid console handle
myConsoleDevType = SYS_CONSOLE_DeviceGet(myConsoleHandle);

Remarks

None.