ShellPkg: Standardized HP Copyright Message String

[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShellDynamicCommand.h

/** @file\r
  EFI Shell Dynamic Command registration protocol\r
\r
  (C) Copyright 2012-2014 Hewlett-Packard Development Company, L.P.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL__\r
#define __EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL__\r
\r
#include <ShellBase.h>\r
#include <Protocol/EfiShellParameters.h>\r
#include <Protocol/EfiShell.h>\r
\r
\r
// {3C7200E9-005F-4EA4-87DE-A3DFAC8A27C3}\r
#define EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID \\r
  { \\r
  0x3c7200e9, 0x005f, 0x4ea4, { 0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3 } \\r
  }\r
\r
\r
//\r
// Define for forward reference.\r
//\r
typedef struct _EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL;\r
\r
\r
/**\r
  This is the shell command handler function pointer callback type.  This\r
  function handles the command when it is invoked in the shell.\r
\r
  @param[in] This                   The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.\r
  @param[in] SystemTable            The pointer to the system table.\r
  @param[in] ShellParameters        The parameters associated with the command.\r
  @param[in] Shell                  The instance of the shell protocol used in the context\r
                                    of processing this command.\r
\r
  @return EFI_SUCCESS               the operation was sucessful\r
  @return other                     the operation failed.\r
**/\r
typedef\r
SHELL_STATUS\r
(EFIAPI * SHELL_COMMAND_HANDLER)(\r
  IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL    *This,\r
  IN EFI_SYSTEM_TABLE                      *SystemTable,\r
  IN EFI_SHELL_PARAMETERS_PROTOCOL         *ShellParameters,\r
  IN EFI_SHELL_PROTOCOL                    *Shell\r
  );\r
\r
/**\r
  This is the command help handler function pointer callback type.  This\r
  function is responsible for displaying help information for the associated\r
  command.\r
\r
  @param[in] This                   The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.\r
  @param[in] Language               The pointer to the language string to use.\r
\r
  @return string                    Pool allocated help string, must be freed by caller\r
**/\r
typedef\r
CHAR16*\r
(EFIAPI * SHELL_COMMAND_GETHELP)(\r
  IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL    *This,\r
  IN CONST CHAR8                           *Language\r
  );\r
\r
/// EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL protocol structure.\r
struct _EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL {\r
  \r
  CONST CHAR16           *CommandName;\r
  SHELL_COMMAND_HANDLER  Handler;\r
  SHELL_COMMAND_GETHELP  GetHelp;\r
\r
};\r
\r
extern EFI_GUID gEfiShellDynamicCommandProtocolGuid;\r
\r
#endif\r