Hotkey.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Provides a way for 3rd party applications to register themselves for launch by the
Boot Manager based on hot key
Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.<BR>
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _HOTKEY_H_
#define _HOTKEY_H_
#include "Bds.h"
#include "String.h"
#define SET_BOOT_OPTION_SUPPORT_KEY_COUNT(a, c) { \
}
typedef struct {
#define VAR_KEY_ORDER L"KeyOrder"
/**
Create Key#### for the given hotkey.
@param KeyOption - The Hot Key Option to be added.
@param KeyOptionNumber - The key option number for Key#### (optional).
@retval EFI_SUCCESS Register hotkey successfully.
@retval EFI_INVALID_PARAMETER The hotkey option is invalid.
**/
);
/**
Delete Key#### for the given Key Option number.
@param KeyOptionNumber - Key option number for Key####
@retval EFI_SUCCESS Unregister hotkey successfully.
@retval EFI_NOT_FOUND No Key#### is found for the given Key Option number.
**/
);
/**
Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
@param VOID
@retval EFI_SUCCESS Hotkey services successfully initialized.
**/
);
/**
Try to boot the boot option triggered by hotkey.
@retval EFI_SUCCESS There is HotkeyBootOption & it is processed
@retval EFI_NOT_FOUND There is no HotkeyBootOption
**/
);
#endif