FileHandleWrappers.h File Reference

Go to the source code of this file.

Data Structures
struct	SHELL_LINE_LIST
struct	SHELL_LINE_LOG

Functions
EFI_FILE_PROTOCOL *	CreateFileInterfaceEnv (CONST CHAR16 *EnvName)
EFI_FILE_PROTOCOL *	CreateFileInterfaceMem (IN CONST BOOLEAN Unicode)
EFI_FILE_PROTOCOL *	CreateFileInterfaceFile (IN CONST EFI_FILE_PROTOCOL *Template, IN CONST BOOLEAN Unicode)

Variables
EFI_FILE_PROTOCOL	FileInterfaceStdIn
EFI_FILE_PROTOCOL	FileInterfaceStdOut
EFI_FILE_PROTOCOL	FileInterfaceStdErr
EFI_FILE_PROTOCOL	FileInterfaceNulFile

Detailed Description

EFI_FILE_PROTOCOL wrappers for other items (Like Environment Variables, StdIn, StdOut, StdErr, etc...)

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

Definition in file FileHandleWrappers.h.

Function Documentation

CreateFileInterfaceEnv()

EFI_FILE_PROTOCOL * CreateFileInterfaceEnv

(

CONST CHAR16 *

EnvName

)

Creates a EFI_FILE_PROTOCOL (almost) object for using to access environment variables through file operations.

Parameters

EnvName

The name of the Environment Variable to be operated on.

Return values

NULL	Memory could not be allocated.

Returns

other a pointer to an EFI_FILE_PROTOCOL structure

CreateFileInterfaceFile()

EFI_FILE_PROTOCOL * CreateFileInterfaceFile	(	IN CONST EFI_FILE_PROTOCOL *	Template,
		IN CONST BOOLEAN	Unicode
	)

Creates a EFI_FILE_PROTOCOL (almost) object for using to access a file entirely with unicode awareness through file operations.

Parameters

[in]	Template	The pointer to the handle to start with.
[in]	Unicode	TRUE if the data is UNICODE, FALSE otherwise.

Return values

NULL	Memory could not be allocated.

Returns

other a pointer to an EFI_FILE_PROTOCOL structure

Create a file interface with unicode information.

This will create a new EFI_FILE_PROTOCOL identical to the Templace except that the new one has Unicode and Ascii knowledge.

Parameters

[in]	Template	A pointer to the EFI_FILE_PROTOCOL object.
[in]	Unicode	TRUE for UCS-2, FALSE for ASCII.

Returns

a new EFI_FILE_PROTOCOL object to be used instead of the template.

Definition at line 2171 of file FileHandleWrappers.c.

CreateFileInterfaceMem()

EFI_FILE_PROTOCOL * CreateFileInterfaceMem

(

IN CONST BOOLEAN

Unicode

)

Creates a EFI_FILE_PROTOCOL (almost) object for using to access a file entirely in memory through file operations.

Parameters

[in]

Unicode

TRUE if the data is UNICODE, FALSE otherwise.

Return values

NULL	Memory could not be allocated.

Returns

other a pointer to an EFI_FILE_PROTOCOL structure

Creates a EFI_FILE_PROTOCOL (almost) object for using to access a file entirely in memory through file operations.

Parameters

[in]

Unicode

Boolean value with TRUE for Unicode and FALSE for Ascii.

Return values

NULL	Memory could not be allocated.

Returns

other A pointer to an EFI_FILE_PROTOCOL structure.

Definition at line 1767 of file FileHandleWrappers.c.

Variable Documentation

FileInterfaceNulFile

EFI_FILE_PROTOCOL FileInterfaceNulFile

extern

FILE style interface for NUL file.

Definition at line 1001 of file FileHandleWrappers.c.

FileInterfaceStdErr

EFI_FILE_PROTOCOL FileInterfaceStdErr

extern

FILE styte interfaces for StdErr.

Definition at line 987 of file FileHandleWrappers.c.

FileInterfaceStdIn

EFI_FILE_PROTOCOL FileInterfaceStdIn

extern

FILE styte interfaces for StdIn.

Definition at line 959 of file FileHandleWrappers.c.

FileInterfaceStdOut

EFI_FILE_PROTOCOL FileInterfaceStdOut

extern

FILE styte interfaces for StdOut.

Definition at line 973 of file FileHandleWrappers.c.