Specifications

32 Version 2.0
EFI_SHELL_PROTOCOL.GetHelpText()
Summary
Return help information about a specific command.
Prototype
typedef
EFI_STATUS
(EFIAPI *EFI_SHELL_GET_HELP_TEXT) (
IN CONST CHAR16 *Command,
IN CONST CHAR16 *Sections,
OUT CHAR16 **HelpText
);
Parameters
Command
Points to the null-terminated UEFI Shell command name.
Sections
Points to the null-terminated comma-delimited section names to return. If NULL,
then all sections will be returned.
HelpText
On return, points to a callee-allocated buffer containing all specified help text.
Description
This function returns the help information for the specified command. The help text
can be internal to the shell or can be from a UEFI Shell manual page, as described in
Appendix B
If
Sections is specified, then each section name listed will be compared in a case-
sensitive manner, to the section names described in Appendix B. If the section exists,
it
will be appended to the returned help text. If the section does not exist, no
information will be returned. If Sections is NULL, then all help text information
available will be returned.
Status Codes Returned
EFI_SUCCESS The help text was returned.
EFI_OUT_OF_RESOURCES The necessary buffer could not be allocated to hold the returned
help text.
EFI_INVALID_PARAMETER HelpText is NULL
EFI_NOT_FOUND There is no help text available for Command.