TianoCore EDK2 master
Loading...
Searching...
No Matches
UefiShellCEntryLib.c File Reference

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI ShellCEntryLib (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 

Detailed Description

Provides application point extension for "C" style main function

Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file UefiShellCEntryLib.c.

Function Documentation

◆ ShellCEntryLib()

EFI_STATUS EFIAPI ShellCEntryLib ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

UEFI entry point for an application that will in turn call the ShellAppMain function which has parameters similar to a standard C main function.

An application that uses UefiShellCEntryLib must have a ShellAppMain function as prototyped in Include/Library/ShellCEntryLib.h.

Note that the Shell uses POSITIVE integers for error values, while UEFI uses NEGATIVE values. If the application is to be used within a script, it needs to return one of the SHELL_STATUS values defined in Protocol/Shell.h.

Parameters
ImageHandleThe image handle of the UEFI Application.
SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe application exited normally.
OtherAn error occurred.

Definition at line 40 of file UefiShellCEntryLib.c.