4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides interface to EFI_FILE_HANDLE functionality.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The tag for use in identifying UNICODE files.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If the file is UNICODE, the first 16 bits of the file will equal this value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves information about the file for the handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified and stores it in the allocated pool memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function allocates a buffer to store the file's information. It is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller's responsibility to free the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle of the file for which information is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being requested.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval NULL Information could not be retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval !NULL The information about the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets the information about the file for the opened handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle of the file for which information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileInfo The information to set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The information was set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no medium.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was opened read only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reads information from an opened file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is not a directory, the function reads the requested number of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bytes from the file at the file's current position and returns them in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the read goes beyond the end of the file, the read length is truncated to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync end of the file. The file's current position is increased by the number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. If FileHandle is a directory, the function reads the directory entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync at the file's current position and returns the entry in Buffer. If the Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not large enough to hold the current directory entry, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferSize is set to be the size of the buffer needed to read the entry. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync success, the current position is updated to the next directory entry. If there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are no more directory entries, the read returns a zero-length buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_FILE_INFO is the structure returned as the directory entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The opened file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize On input, the size of buffer in bytes. On return,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the number of bytes written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Buffer The buffer to put read data into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Write data to a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function writes the specified number of bytes to the file at the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file position. The current file position is advanced the actual number of bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync written, which is returned in BufferSize. Partial writes only occur when there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has been a data error during the write attempt (such as "volume space full").
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The file is automatically grown to hold the data if required. Direct writes to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync opened directories are not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The opened file for writing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize On input, the number of bytes in Buffer. On output,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the number of bytes written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer The buffer containing data to write is stored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Data was written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Writes to an open directory are not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The device is write-protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was opened for read only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_FULL The volume is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Close an open file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function closes a specified file handle. All "dirty" cached file data is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync flushed to the device, and the file is closed. In all cases the handle is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle to close.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file handle was closed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delete a file and close the handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function closes and deletes a file. In all cases the file handle is closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned, but the handle is still closed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle to delete.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was closed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WARN_DELETE_FAILURE The handle was closed, but the file was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval INVALID_PARAMETER One of the parameters has an invalid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the current position in a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets the current file position for the handle to the position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supplied. With the exception of moving to position 0xFFFFFFFFFFFFFFFF, only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync absolute positioning is supported, and moving past the end of the file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync allowed (a subsequent write would grow the file). Moving to position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is a directory, the only position that may be set is zero. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has the effect of starting the read process of the directory entries over again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle on which the position is being set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Position The byte position from the begining of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed sucessfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The request for non-zero is not valid on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval INVALID_PARAMETER One of the parameters has an invalid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets a file's current position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function retrieves the current file position for the file handle. For
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directories, the current file position has no meaning outside of the file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync system driver. As such, the operation is not supported. An error is returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if FileHandle is a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The open file handle on which to get the position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Position The byte position from begining of file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval INVALID_PARAMETER One of the parameters has an invalid value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The request is not valid on directories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Flushes data on a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function flushes all modified data associated with a file to a device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle on which to flush data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_WRITE_PROTECTED The file or medium is write protected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The file was opened for read only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to determine if a given handle is a directory handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If DirHandle is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Open the file information on the DirHandle, and verify that the Attribute
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync includes EFI_FILE_DIRECTORY bit set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DirHandle The handle to open the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS DirHandle is a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND DirHandle is not a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** Retrieve first entry from a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function takes an open directory handle and gets information from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync first entry in the directory. A buffer is allocated to contain
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the information and a pointer to the buffer is returned in *Buffer. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller can use FileHandleFindNextFile() to get subsequent directory entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The buffer will be freed by FileHandleFindNextFile() when the last directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync entry is read. Otherwise, the caller must free the buffer, using FreePool,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when finished with it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DirHandle The file handle of the directory to search.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Buffer The pointer to pointer to buffer for file's information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Found the first file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Cannot find the directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Others The status of FileHandleGetInfo, FileHandleSetPosition,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or FileHandleRead.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** Retrieve next entries from a directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To use this function, the caller must first call the FileHandleFindFirstFile()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function to get the first directory entry. Subsequent directory entries are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieved by using the FileHandleFindNextFile() function. This function can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be called several times to get each entry from the directory. If the call of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FileHandleFindNextFile() retrieved the last directory entry, the next call of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function will set *NoFile to TRUE and free the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DirHandle The file handle of the directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Buffer The pointer to buffer for file's information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] NoFile The pointer to boolean when last file is found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Found the next file, or reached last file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA The device has no media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device reported an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieve the size of a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is NULL then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Size is NULL then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function extracts the file size info from the FileHandle's EFI_FILE_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle from which size is retrieved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Size The pointer to size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Cannot access the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the size of a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If FileHandle is NULL then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function changes the file size info from the FileHandle's EFI_FILE_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FileHandle The file handle whose size is to be changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Size The new size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Cannot access the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to get a full filename given a EFI_FILE_HANDLE somewhere lower on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync directory 'stack'.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle Handle to the Directory or File to create path to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] FullFileName Pointer to pointer to generated full file name. It
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is the responsibility of the caller to free this memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with a call to FreePool().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful and FullFileName is valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FullFileName was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_MEMORY A memory allocation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to read a single line (up to but not including the \n) from a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the position upon start is 0, then the Ascii Boolean will be set. This should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maintained and not changed for all operations with the same file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle FileHandle to read from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Buffer The pointer to buffer to read into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Size The pointer to number of bytes in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Truncate If the buffer is large enough, this has no effect.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the buffer is is too small and Truncate is TRUE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the line will be truncated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the buffer is is too small and Truncate is FALSE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then no read will occur.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Ascii Boolean value for indicating whether the file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ascii (TRUE) or UCS2 (FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful. The line is stored in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Handle was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Size was NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Size was updated to the minimum space required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa FileHandleRead
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to read a single line from a file. The \n is not included in the returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer. The returned buffer must be callee freed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the position upon start is 0, then the Ascii Boolean will be set. This should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maintained and not changed for all operations with the same file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle FileHandle to read from.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Ascii Boolean value for indicating whether the file is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ascii (TRUE) or UCS2 (FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The line of text from the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa FileHandleReadLine
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to write a line of unicode text to a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Handle is NULL, ASSERT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle FileHandle to write to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer Buffer to write, if NULL the function will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync take no action and return EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data was written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other Failure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa FileHandleWrite
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to take a formatted argument and print it to a file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle The file handle for the file to write to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Format The format argument (see printlib for the format specifier).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ... The variable arguments for the format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval other A return value from FileHandleWriteLine.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @sa FileHandleWriteLine
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Function to determine if a FILE_HANDLE is at the end of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This will NOT work on directories.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Handle is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Handle The file handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The position is at the end of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The position is not at the end of the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif //_FILE_HANDLE_LIBRARY_HEADER_