TianoCore EDK2 master
Loading...
Searching...
No Matches
FileImage.h File Reference
#include "HexEditor.h"

Go to the source code of this file.

Functions

EFI_STATUS HFileImageInit (VOID)
 
EFI_STATUS HFileImageCleanup (VOID)
 
EFI_STATUS HFileImageBackup (VOID)
 
EFI_STATUS HFileImageRead (IN CONST CHAR16 *FileName, IN BOOLEAN Recover)
 
EFI_STATUS HFileImageSave (IN CHAR16 *FileName)
 

Detailed Description

Defines FileImage - the view of the file that is visible at any point, as well as the event handlers for editing the file

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

Definition in file FileImage.h.

Function Documentation

◆ HFileImageBackup()

EFI_STATUS HFileImageBackup ( VOID  )

Backup function for HFileImage. Only a few fields need to be backup. This is for making the file buffer refresh as few as possible.

Return values
EFI_SUCCESSThe operation was successful.
EFI_OUT_OF_RESOURCESA memory allocation failed.

Definition at line 64 of file FileImage.c.

◆ HFileImageCleanup()

EFI_STATUS HFileImageCleanup ( VOID  )

Cleanup function for HFileImage.

Return values
EFI_SUCCESSThe operation was successful.

Definition at line 83 of file FileImage.c.

◆ HFileImageInit()

EFI_STATUS HFileImageInit ( VOID  )

Initialization function for HFileImage

Return values
EFI_SUCCESSThe operation was successful.

Definition at line 38 of file FileImage.c.

◆ HFileImageRead()

EFI_STATUS HFileImageRead ( IN CONST CHAR16 *  FileName,
IN BOOLEAN  Recover 
)

Read a file from disk into HBufferImage.

Parameters
[in]FileNamefilename to read.
[in]Recoverif is for recover, no information print.
Return values
EFI_SUCCESSThe operation was successful.
EFI_OUT_OF_RESOURCESA memory allocation failed.
EFI_LOAD_ERRORA load error occurred.

Definition at line 137 of file FileImage.c.

◆ HFileImageSave()

EFI_STATUS HFileImageSave ( IN CHAR16 *  FileName)

Save lines in HBufferImage to disk.

Parameters
[in]FileNameThe file name.
Return values
EFI_SUCCESSThe operation was successful.
EFI_OUT_OF_RESOURCESA memory allocation failed.
EFI_LOAD_ERRORA load error occurred.

Definition at line 250 of file FileImage.c.