UefiShellLib.h File Reference

#include <Uefi.h>
#include <Guid/FileInfo.h>
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/EfiShellInterface.h>
#include <Protocol/EfiShellEnvironment2.h>
#include <Protocol/Shell.h>
#include <Protocol/ShellParameters.h>
#include <Protocol/UnicodeCollation.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DevicePathLib.h>
#include <Library/PcdLib.h>
#include <Library/FileHandleLib.h>
#include <Library/PrintLib.h>
#include <Library/UefiLib.h>
#include <Library/HiiLib.h>
#include <Library/ShellLib.h>

Go to the source code of this file.

Data Structures
struct	FILE_HANDLE_FUNCTION_MAP

Functions
BOOLEAN	InternalShellIsHexOrDecimalNumber (IN CONST CHAR16 *String, IN CONST BOOLEAN ForceHex, IN CONST BOOLEAN StopAtSpace, IN CONST BOOLEAN TimeNumbers)
EFI_STATUS	InternalShellStripQuotes (IN CONST CHAR16 *OriginalString, OUT CHAR16 **CleanString)

Detailed Description

Provides interface to shell functionality for shell commands and applications.

(C) Copyright 2016 Hewlett Packard Enterprise Development LP
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiShellLib.h.

Function Documentation

InternalShellIsHexOrDecimalNumber()

BOOLEAN InternalShellIsHexOrDecimalNumber	(	IN CONST CHAR16 *	String,
		IN CONST BOOLEAN	ForceHex,
		IN CONST BOOLEAN	StopAtSpace,
		IN CONST BOOLEAN	TimeNumbers
	)

Function to determin if an entire string is a valid number.

If Hex it must be preceeded with a 0x or has ForceHex, set TRUE.

Parameters

[in]	String	The string to evaluate.
[in]	ForceHex	TRUE - always assume hex.
[in]	StopAtSpace	TRUE to halt upon finding a space, FALSE to keep going.
[in]	TimeNumbers	TRUE to allow numbers with ":", FALSE otherwise.

Return values

TRUE	It is all numeric (dec/hex) characters.
FALSE	There is a non-numeric character.

Definition at line 3844 of file UefiShellLib.c.

InternalShellStripQuotes()

EFI_STATUS InternalShellStripQuotes	(	IN CONST CHAR16 *	OriginalString,
		OUT CHAR16 **	CleanString
	)

Cleans off all the quotes in the string.

Parameters

[in]	OriginalString	pointer to the string to be cleaned.
[out]	CleanString	The new string with all quotes removed. Memory allocated in the function and free by caller.

Return values

EFI_SUCCESS

The operation was successful.

Definition at line 4572 of file UefiShellLib.c.