1.2.4.4.5 SYS_CONSOLE_DeviceGet Function

1.2.4.4.5 C

SYS_CONSOLE_DEVICE SYS_CONSOLE_DeviceGet( const SYS_CONSOLE_HANDLE handle)

1.2.4.4.5 Summary

Returns the device type for a given console instance.

1.2.4.4.5 Description

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

1.2.4.4.5 Preconditions

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

1.2.4.4.5 Parameters

ParametersDescription
handleA valid handle to the console instance

1.2.4.4.5 Returns

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

1.2.4.4.5 Example

SYS_CONSOLE_HANDLE myConsoleHandle;
SYS_CONSOLE_DEVICE myConsoleDevType

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

1.2.4.4.5 Remarks

None.