AppleKeyMapDatabase.h File Reference

#include <IndustryStandard/AppleHid.h>

Go to the source code of this file.

Data Structures
struct	APPLE_KEY_MAP_DATABASE_PROTOCOL

Macros
#define	APPLE_KEY_MAP_DATABASE_PROTOCOL_REVISION   0x00010000
#define	APPLE_KEY_MAP_DATABASE_PROTOCOL_GUID

Typedefs
typedef struct APPLE_KEY_MAP_DATABASE_PROTOCOL	APPLE_KEY_MAP_DATABASE_PROTOCOL
typedef EFI_STATUS(EFIAPI *	KEY_MAP_CREATE_KEY_STROKES_BUFFER) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN BufferLength, OUT UINTN *Index)
typedef EFI_STATUS(EFIAPI *	KEY_MAP_REMOVE_KEY_STROKES_BUFFER) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN Index)
typedef EFI_STATUS(EFIAPI *	KEY_MAP_SET_KEY_STROKES_KEYS) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN Index, IN APPLE_MODIFIER_MAP Modifiers, IN UINTN NumberOfKeyCodes, IN APPLE_KEY_CODE *KeyCodes)

Variables
EFI_GUID	gAppleKeyMapDatabaseProtocolGuid

Detailed Description

Copyright (C) 2014 - 2016, Download-Fritz. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file AppleKeyMapDatabase.h.

Macro Definition Documentation

APPLE_KEY_MAP_DATABASE_PROTOCOL_GUID

#define APPLE_KEY_MAP_DATABASE_PROTOCOL_GUID

Value:

  { 0x584B9EBE, 0x80C1, 0x4BD6,               \
    { 0x98, 0xB0, 0xA7, 0x78, 0x6E, 0xC2, 0xF2, 0xE2 } }

Definition at line 22 of file AppleKeyMapDatabase.h.

APPLE_KEY_MAP_DATABASE_PROTOCOL_REVISION

#define APPLE_KEY_MAP_DATABASE_PROTOCOL_REVISION   0x00010000

Definition at line 19 of file AppleKeyMapDatabase.h.

Typedef Documentation

APPLE_KEY_MAP_DATABASE_PROTOCOL

typedef struct APPLE_KEY_MAP_DATABASE_PROTOCOL APPLE_KEY_MAP_DATABASE_PROTOCOL

Definition at line 26 of file AppleKeyMapDatabase.h.

KEY_MAP_CREATE_KEY_STROKES_BUFFER

typedef EFI_STATUS(EFIAPI * KEY_MAP_CREATE_KEY_STROKES_BUFFER) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN BufferLength, OUT UINTN *Index)

Creates a new key stroke buffer with a given number of keys allocated. The index within the database is returned.

Parameters

[in]	This	Protocol instance pointer.
[in]	BufferLength	The amount of keys to reserve.
[out]	Index	The assigned index of the created buffer.

Return values

EFI_SUCCESS	The key stroke buffer has been created.
EFI_OUT_OF_RESOURCES	The memory necessary to complete the operation could not be allocated.
other	An error returned by a sub-operation.

Definition at line 43 of file AppleKeyMapDatabase.h.

KEY_MAP_REMOVE_KEY_STROKES_BUFFER

typedef EFI_STATUS(EFIAPI * KEY_MAP_REMOVE_KEY_STROKES_BUFFER) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN Index)

Removes the key stroke buffer specified by its index from the database.

Parameters

[in]	This	Protocol instance pointer.
[in]	Index	The index of the key stroke buffer to remove.

Return values

EFI_SUCCESS	The key stroke buffer has been removed.
EFI_NOT_FOUND	No key stroke buffer could be found for the given index.
other	An error returned by a sub-operation.

Definition at line 63 of file AppleKeyMapDatabase.h.

KEY_MAP_SET_KEY_STROKES_KEYS

typedef EFI_STATUS(EFIAPI * KEY_MAP_SET_KEY_STROKES_KEYS) (IN APPLE_KEY_MAP_DATABASE_PROTOCOL *This, IN UINTN Index, IN APPLE_MODIFIER_MAP Modifiers, IN UINTN NumberOfKeyCodes, IN APPLE_KEY_CODE *KeyCodes)

Sets the key strokes of the key stroke buffer to the given KeyCodes buffer.

Parameters

[in]	This	Protocol instance pointer.
[in]	Index	The index of the key stroke buffer to edit.
[in]	Modifiers	The key modifiers manipulating the given keys.
[in]	NumberOfKeyCodes	The number of keys contained in KeyCodes.
[in]	KeyCodes	An array of keys to add to the specified key set.

Return values

EFI_SUCCESS	The given keys were set for the specified key set.
EFI_OUT_OF_RESOURCES	The memory necessary to complete the operation could not be allocated.
EFI_NOT_FOUND	No key stroke buffer could be found for the given index.
other	An error returned by a sub-operation.

Definition at line 89 of file AppleKeyMapDatabase.h.

Variable Documentation

gAppleKeyMapDatabaseProtocolGuid

EFI_GUID gAppleKeyMapDatabaseProtocolGuid

extern

Definition at line 17 of file UserGlobalVar.c.