123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- /** @file
- Header file for helper functions useful for accessing files.
- Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #ifndef _EFI_MEMORY_FILE_H
- #define _EFI_MEMORY_FILE_H
- #include <stdio.h>
- #include <stdlib.h>
- #include <Common/UefiBaseTypes.h>
- //
- // Common data structures
- //
- typedef struct {
- CHAR8 *FileImage;
- CHAR8 *Eof;
- CHAR8 *CurrentFilePointer;
- } MEMORY_FILE;
- //
- // Functions declarations
- //
- EFI_STATUS
- GetMemoryFile (
- IN CHAR8 *InputFileName,
- OUT EFI_HANDLE *OutputMemoryFile
- )
- ;
- /**
- Routine Description:
- This opens a file, reads it into memory and returns a memory file
- object.
- Arguments:
- InputFile Memory file image.
- OutputMemoryFile Handle to memory file
- Returns:
- EFI_STATUS
- OutputMemoryFile is valid if !EFI_ERROR
- **/
- EFI_STATUS
- FreeMemoryFile (
- IN EFI_HANDLE InputMemoryFile
- )
- ;
- /**
- Routine Description:
- Frees all memory associated with the input memory file.
- Arguments:
- InputMemoryFile Handle to memory file
- Returns:
- EFI_STATUS
- **/
- CHAR8 *
- ReadMemoryFileLine (
- IN EFI_HANDLE InputMemoryFile
- )
- ;
- /**
- Routine Description:
- This function reads a line from the memory file. The newline characters
- are stripped and a null terminated string is returned.
- If the string pointer returned is non-NULL, then the caller must free the
- memory associated with this string.
- Arguments:
- InputMemoryFile Handle to memory file
- Returns:
- NULL if error or EOF
- NULL character termincated string otherwise (MUST BE FREED BY CALLER)
- **/
- #endif
|