#include <Protocol/Shell.h>
#include <Protocol/ShellParameters.h>

Include dependency graph for ShellDynamicCommand.h:

Classes
struct	_EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL
	EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL protocol structure. More...

Macros
#define	EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID

Typedefs
typedef struct _EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL	EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL

typedef SHELL_STATUS(EFIAPI *	SHELL_COMMAND_HANDLER) (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL This, IN EFI_SYSTEM_TABLE SystemTable, IN EFI_SHELL_PARAMETERS_PROTOCOL ShellParameters, IN EFI_SHELL_PROTOCOL Shell)

typedef CHAR16 (EFIAPI	SHELL_COMMAND_GETHELP) (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL This, IN CONST CHAR8 Language)

Variables
EFI_GUID	gEfiShellDynamicCommandProtocolGuid

Detailed Description

EFI Shell Dynamic Command registration protocol

(C) Copyright 2012-2014 Hewlett-Packard Development Company, L.P.
Copyright (c) 2016 - 2018, Intel Corporation. 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.

Macro Definition Documentation

◆ EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID

#define EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID

Value:

  { \
  0x3c7200e9, 0x005f, 0x4ea4, { 0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3 } \
  }

Typedef Documentation

◆ EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL

typedef struct _EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL

◆ SHELL_COMMAND_GETHELP

typedef CHAR16 *(EFIAPI * SHELL_COMMAND_GETHELP) (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN CONST CHAR8 *Language)

This is the command help handler function pointer callback type. This function is responsible for displaying help information for the associated command.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	Language	The pointer to the language string to use.

Returns: string Pool allocated help string, must be freed by caller

◆ SHELL_COMMAND_HANDLER

typedef SHELL_STATUS(EFIAPI * SHELL_COMMAND_HANDLER) (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN EFI_SYSTEM_TABLE *SystemTable, IN EFI_SHELL_PARAMETERS_PROTOCOL *ShellParameters, IN EFI_SHELL_PROTOCOL *Shell)

This is the shell command handler function pointer callback type. This function handles the command when it is invoked in the shell.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	SystemTable	The pointer to the system table.
[in]	ShellParameters	The parameters associated with the command.
[in]	Shell	The instance of the shell protocol used in the context of processing this command.

Returns: EFI_SUCCESS the operation was sucessful; other the operation failed.

Variable Documentation

◆ gEfiShellDynamicCommandProtocolGuid

EFI_GUID gEfiShellDynamicCommandProtocolGuid

extern

Classes

Macros

Typedefs

Variables