VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IKeyboard Interface Reference

The IKeyboard interface represents the virtual machine's keyboard. More...

Public Member Functions

void putScancode (in long scancode)
 Sends a scancode to the keyboard.
void putScancodes (in long[] scancodes,[retval] out unsigned long codesStored)
 Sends an array of scancodes to the keyboard.
void putCAD ()
 Sends the Ctrl-Alt-Del sequence to the keyboard.

Public Attributes

readonly attribute IEventSource eventSource
 Event source for keyboard events.

Detailed Description

The IKeyboard interface represents the virtual machine's keyboard.

Used in IConsole::keyboard.

Use this interface to send keystrokes or the Ctrl-Alt-Del sequence to the virtual machine.

Interface ID:
{F6916EC5-A881-4237-898F-7DE58CF88672}

Member Function Documentation

void IKeyboard::putScancode ( in long  scancode)

Sends a scancode to the keyboard.

  @par Expected result codes:
<table><tr>

VBOX_E_IPRT_ERROR

Could not send scan code to virtual keyboard.

void IKeyboard::putScancodes ( in long[]  scancodes,
[retval] out unsigned long  codesStored 
)

Sends an array of scancodes to the keyboard.

  @par Expected result codes:
<table><tr>

VBOX_E_IPRT_ERROR

Could not send all scan codes to virtual keyboard.

void IKeyboard::putCAD ( )

Sends the Ctrl-Alt-Del sequence to the keyboard.

This function is nothing special, it is just a convenience function calling IKeyboard::putScancodes with the proper scancodes.

Expected result codes:
VBOX_E_IPRT_ERROR Could not send all scan codes to virtual keyboard.

Member Data Documentation

readonly attribute IEventSource IKeyboard::eventSource

Event source for keyboard events.