]>
Commit | Line | Data |
---|---|---|
d2b4564b | 1 | /** @file\r |
2 | Provides interface to EFI_FILE_HANDLE functionality.\r | |
3 | \r | |
0f705029 | 4 | Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r |
1e6e84c7 | 5 | This program and the accompanying materials\r |
b3011f40 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
d2b4564b | 9 | \r |
b3011f40 | 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
d2b4564b | 12 | \r |
13 | **/\r | |
14 | \r | |
a405b86d | 15 | #ifndef _FILE_HANDLE_LIBRARY_HEADER_\r |
b3011f40 | 16 | #define _FILE_HANDLE_LIBRARY_HEADER_\r |
17 | \r | |
a405b86d | 18 | #include <Protocol/SimpleFileSystem.h>\r |
0f705029 | 19 | #include <Guid/FileInfo.h>\r |
a405b86d | 20 | \r |
21 | /// The tag for use in identifying UNICODE files.\r | |
22 | /// If the file is UNICODE, the first 16 bits of the file will equal this value.\r | |
4bbdc0e1 | 23 | extern CONST UINT16 gUnicodeFileTag;\r |
b3011f40 | 24 | \r |
d2b4564b | 25 | /**\r |
a405b86d | 26 | This function retrieves information about the file for the handle\r |
27 | specified and stores it in the allocated pool memory.\r | |
d2b4564b | 28 | \r |
1e6e84c7 | 29 | This function allocates a buffer to store the file's information. It is the\r |
125c2cf4 | 30 | caller's responsibility to free the buffer.\r |
d2b4564b | 31 | \r |
a405b86d | 32 | @param[in] FileHandle The file handle of the file for which information is\r |
33 | being requested.\r | |
d2b4564b | 34 | \r |
a405b86d | 35 | @retval NULL Information could not be retrieved.\r |
36 | @retval !NULL The information about the file.\r | |
d2b4564b | 37 | **/\r |
38 | EFI_FILE_INFO*\r | |
39 | EFIAPI\r | |
40 | FileHandleGetInfo (\r | |
41 | IN EFI_FILE_HANDLE FileHandle\r | |
42 | );\r | |
43 | \r | |
44 | /**\r | |
a405b86d | 45 | This function sets the information about the file for the opened handle\r |
d2b4564b | 46 | specified.\r |
47 | \r | |
a405b86d | 48 | @param[in] FileHandle The file handle of the file for which information\r |
125c2cf4 | 49 | is being set.\r |
d2b4564b | 50 | \r |
a405b86d | 51 | @param[in] FileInfo The information to set.\r |
d2b4564b | 52 | \r |
b0934ac4 | 53 | @retval EFI_SUCCESS The information was set.\r |
a405b86d | 54 | @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.\r |
125c2cf4 | 55 | @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.\r |
b0934ac4 | 56 | @retval EFI_NO_MEDIA The device has no medium.\r |
57 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
58 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
59 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
a405b86d | 60 | @retval EFI_ACCESS_DENIED The file was opened read only.\r |
61 | @retval EFI_VOLUME_FULL The volume is full.\r | |
d2b4564b | 62 | **/\r |
63 | EFI_STATUS\r | |
64 | EFIAPI\r | |
65 | FileHandleSetInfo (\r | |
b0934ac4 | 66 | IN EFI_FILE_HANDLE FileHandle,\r |
d2b4564b | 67 | IN CONST EFI_FILE_INFO *FileInfo\r |
68 | );\r | |
69 | \r | |
70 | /**\r | |
71 | This function reads information from an opened file.\r | |
72 | \r | |
1e6e84c7 | 73 | If FileHandle is not a directory, the function reads the requested number of\r |
74 | bytes from the file at the file's current position and returns them in Buffer.\r | |
d2b4564b | 75 | If the read goes beyond the end of the file, the read length is truncated to the\r |
1e6e84c7 | 76 | end of the file. The file's current position is increased by the number of bytes\r |
77 | returned. If FileHandle is a directory, the function reads the directory entry\r | |
78 | at the file's current position and returns the entry in Buffer. If the Buffer\r | |
79 | is not large enough to hold the current directory entry, then\r | |
80 | EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.\r | |
81 | BufferSize is set to be the size of the buffer needed to read the entry. On\r | |
82 | success, the current position is updated to the next directory entry. If there\r | |
83 | are no more directory entries, the read returns a zero-length buffer.\r | |
d2b4564b | 84 | EFI_FILE_INFO is the structure returned as the directory entry.\r |
85 | \r | |
4ff7e37b ED |
86 | @param[in] FileHandle The opened file handle.\r |
87 | @param[in, out] BufferSize On input, the size of buffer in bytes. On return,\r | |
88 | the number of bytes written.\r | |
89 | @param[out] Buffer The buffer to put read data into.\r | |
d2b4564b | 90 | \r |
b0934ac4 | 91 | @retval EFI_SUCCESS Data was read.\r |
92 | @retval EFI_NO_MEDIA The device has no media.\r | |
93 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
94 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
95 | @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required\r | |
d2b4564b | 96 | size.\r |
97 | \r | |
98 | **/\r | |
99 | EFI_STATUS\r | |
100 | EFIAPI\r | |
101 | FileHandleRead(\r | |
102 | IN EFI_FILE_HANDLE FileHandle,\r | |
103 | IN OUT UINTN *BufferSize,\r | |
104 | OUT VOID *Buffer\r | |
105 | );\r | |
106 | \r | |
107 | /**\r | |
108 | Write data to a file.\r | |
109 | \r | |
1e6e84c7 | 110 | This function writes the specified number of bytes to the file at the current\r |
111 | file position. The current file position is advanced the actual number of bytes\r | |
112 | written, which is returned in BufferSize. Partial writes only occur when there\r | |
113 | has been a data error during the write attempt (such as "volume space full").\r | |
114 | The file is automatically grown to hold the data if required. Direct writes to\r | |
d2b4564b | 115 | opened directories are not supported.\r |
116 | \r | |
4ff7e37b ED |
117 | @param[in] FileHandle The opened file for writing.\r |
118 | @param[in, out] BufferSize On input, the number of bytes in Buffer. On output,\r | |
119 | the number of bytes written.\r | |
120 | @param[in] Buffer The buffer containing data to write is stored.\r | |
125c2cf4 | 121 | \r |
b0934ac4 | 122 | @retval EFI_SUCCESS Data was written.\r |
a405b86d | 123 | @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r |
b0934ac4 | 124 | @retval EFI_NO_MEDIA The device has no media.\r |
125 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
126 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
127 | @retval EFI_WRITE_PROTECTED The device is write-protected.\r | |
128 | @retval EFI_ACCESS_DENIED The file was opened for read only.\r | |
129 | @retval EFI_VOLUME_FULL The volume is full.\r | |
d2b4564b | 130 | **/\r |
131 | EFI_STATUS\r | |
132 | EFIAPI\r | |
133 | FileHandleWrite(\r | |
134 | IN EFI_FILE_HANDLE FileHandle,\r | |
135 | IN OUT UINTN *BufferSize,\r | |
136 | IN VOID *Buffer\r | |
137 | );\r | |
138 | \r | |
1e6e84c7 | 139 | /**\r |
d2b4564b | 140 | Close an open file handle.\r |
141 | \r | |
1e6e84c7 | 142 | This function closes a specified file handle. All "dirty" cached file data is\r |
143 | flushed to the device, and the file is closed. In all cases the handle is\r | |
d2b4564b | 144 | closed.\r |
145 | \r | |
a405b86d | 146 | @param[in] FileHandle The file handle to close.\r |
d2b4564b | 147 | \r |
a405b86d | 148 | @retval EFI_SUCCESS The file handle was closed successfully.\r |
d2b4564b | 149 | **/\r |
150 | EFI_STATUS\r | |
151 | EFIAPI\r | |
152 | FileHandleClose (\r | |
153 | IN EFI_FILE_HANDLE FileHandle\r | |
154 | );\r | |
155 | \r | |
156 | /**\r | |
125c2cf4 | 157 | Delete a file and close the handle.\r |
d2b4564b | 158 | \r |
159 | This function closes and deletes a file. In all cases the file handle is closed.\r | |
1e6e84c7 | 160 | If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is\r |
d2b4564b | 161 | returned, but the handle is still closed.\r |
162 | \r | |
a405b86d | 163 | @param[in] FileHandle The file handle to delete.\r |
d2b4564b | 164 | \r |
a405b86d | 165 | @retval EFI_SUCCESS The file was closed successfully.\r |
166 | @retval EFI_WARN_DELETE_FAILURE The handle was closed, but the file was not\r | |
167 | deleted.\r | |
b0934ac4 | 168 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
d2b4564b | 169 | **/\r |
170 | EFI_STATUS\r | |
171 | EFIAPI\r | |
172 | FileHandleDelete (\r | |
b0934ac4 | 173 | IN EFI_FILE_HANDLE FileHandle\r |
d2b4564b | 174 | );\r |
175 | \r | |
176 | /**\r | |
177 | Set the current position in a file.\r | |
178 | \r | |
1e6e84c7 | 179 | This function sets the current file position for the handle to the position\r |
a405b86d | 180 | supplied. With the exception of moving to position 0xFFFFFFFFFFFFFFFF, only\r |
181 | absolute positioning is supported, and moving past the end of the file is\r | |
182 | allowed (a subsequent write would grow the file). Moving to position\r | |
d2b4564b | 183 | 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.\r |
1e6e84c7 | 184 | If FileHandle is a directory, the only position that may be set is zero. This\r |
a405b86d | 185 | has the effect of starting the read process of the directory entries over again.\r |
d2b4564b | 186 | \r |
a405b86d | 187 | @param[in] FileHandle The file handle on which the position is being set.\r |
00b7cc0f | 188 | @param[in] Position The byte position from the beginning of the file.\r |
d2b4564b | 189 | \r |
00b7cc0f | 190 | @retval EFI_SUCCESS The operation completed successfully.\r |
a405b86d | 191 | @retval EFI_UNSUPPORTED The request for non-zero is not valid on\r |
d2b4564b | 192 | directories.\r |
193 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r | |
194 | **/\r | |
195 | EFI_STATUS\r | |
196 | EFIAPI\r | |
197 | FileHandleSetPosition (\r | |
b0934ac4 | 198 | IN EFI_FILE_HANDLE FileHandle,\r |
199 | IN UINT64 Position\r | |
d2b4564b | 200 | );\r |
201 | \r | |
1e6e84c7 | 202 | /**\r |
125c2cf4 | 203 | Gets a file's current position.\r |
d2b4564b | 204 | \r |
1e6e84c7 | 205 | This function retrieves the current file position for the file handle. For\r |
206 | directories, the current file position has no meaning outside of the file\r | |
a405b86d | 207 | system driver. As such, the operation is not supported. An error is returned\r |
d2b4564b | 208 | if FileHandle is a directory.\r |
209 | \r | |
a405b86d | 210 | @param[in] FileHandle The open file handle on which to get the position.\r |
00b7cc0f | 211 | @param[out] Position The byte position from beginning of file.\r |
d2b4564b | 212 | \r |
a405b86d | 213 | @retval EFI_SUCCESS The operation completed successfully.\r |
d2b4564b | 214 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
a405b86d | 215 | @retval EFI_UNSUPPORTED The request is not valid on directories.\r |
d2b4564b | 216 | **/\r |
217 | EFI_STATUS\r | |
218 | EFIAPI\r | |
219 | FileHandleGetPosition (\r | |
220 | IN EFI_FILE_HANDLE FileHandle,\r | |
221 | OUT UINT64 *Position\r | |
222 | );\r | |
223 | /**\r | |
125c2cf4 | 224 | Flushes data on a file.\r |
1e6e84c7 | 225 | \r |
d2b4564b | 226 | This function flushes all modified data associated with a file to a device.\r |
227 | \r | |
a405b86d | 228 | @param[in] FileHandle The file handle on which to flush data.\r |
d2b4564b | 229 | \r |
230 | @retval EFI_SUCCESS The data was flushed.\r | |
231 | @retval EFI_NO_MEDIA The device has no media.\r | |
232 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
233 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
234 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
235 | @retval EFI_ACCESS_DENIED The file was opened for read only.\r | |
236 | **/\r | |
237 | EFI_STATUS\r | |
238 | EFIAPI\r | |
239 | FileHandleFlush (\r | |
240 | IN EFI_FILE_HANDLE FileHandle\r | |
241 | );\r | |
242 | \r | |
243 | /**\r | |
125c2cf4 | 244 | Function to determine if a given handle is a directory handle.\r |
d2b4564b | 245 | \r |
e84fb6eb | 246 | Open the file information on the DirHandle and verify that the Attribute\r |
d2b4564b | 247 | includes EFI_FILE_DIRECTORY bit set.\r |
248 | \r | |
e84fb6eb | 249 | @param[in] DirHandle Handle to open file.\r |
d2b4564b | 250 | \r |
a405b86d | 251 | @retval EFI_SUCCESS DirHandle is a directory.\r |
e84fb6eb QS |
252 | @retval EFI_INVALID_PARAMETER DirHandle is NULL. \r |
253 | The file information returns from FileHandleGetInfo is NULL. \r | |
a405b86d | 254 | @retval EFI_NOT_FOUND DirHandle is not a directory.\r |
d2b4564b | 255 | **/\r |
256 | EFI_STATUS\r | |
257 | EFIAPI\r | |
258 | FileHandleIsDirectory (\r | |
259 | IN EFI_FILE_HANDLE DirHandle\r | |
260 | );\r | |
261 | \r | |
b0934ac4 | 262 | /** Retrieve first entry from a directory.\r |
d2b4564b | 263 | \r |
b0934ac4 | 264 | This function takes an open directory handle and gets information from the\r |
265 | first entry in the directory. A buffer is allocated to contain\r | |
266 | the information and a pointer to the buffer is returned in *Buffer. The\r | |
267 | caller can use FileHandleFindNextFile() to get subsequent directory entries.\r | |
d2b4564b | 268 | \r |
b0934ac4 | 269 | The buffer will be freed by FileHandleFindNextFile() when the last directory\r |
270 | entry is read. Otherwise, the caller must free the buffer, using FreePool,\r | |
271 | when finished with it.\r | |
272 | \r | |
273 | @param[in] DirHandle The file handle of the directory to search.\r | |
a405b86d | 274 | @param[out] Buffer The pointer to pointer to buffer for file's information.\r |
d2b4564b | 275 | \r |
276 | @retval EFI_SUCCESS Found the first file.\r | |
277 | @retval EFI_NOT_FOUND Cannot find the directory.\r | |
278 | @retval EFI_NO_MEDIA The device has no media.\r | |
279 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
280 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
a405b86d | 281 | @return Others The status of FileHandleGetInfo, FileHandleSetPosition,\r |
282 | or FileHandleRead.\r | |
d2b4564b | 283 | **/\r |
284 | EFI_STATUS\r | |
285 | EFIAPI\r | |
286 | FileHandleFindFirstFile (\r | |
287 | IN EFI_FILE_HANDLE DirHandle,\r | |
288 | OUT EFI_FILE_INFO **Buffer\r | |
289 | );\r | |
d2b4564b | 290 | \r |
b0934ac4 | 291 | /** Retrieve next entries from a directory.\r |
292 | \r | |
293 | To use this function, the caller must first call the FileHandleFindFirstFile()\r | |
294 | function to get the first directory entry. Subsequent directory entries are\r | |
295 | retrieved by using the FileHandleFindNextFile() function. This function can\r | |
296 | be called several times to get each entry from the directory. If the call of\r | |
297 | FileHandleFindNextFile() retrieved the last directory entry, the next call of\r | |
298 | this function will set *NoFile to TRUE and free the buffer.\r | |
d2b4564b | 299 | \r |
b0934ac4 | 300 | @param[in] DirHandle The file handle of the directory.\r |
a405b86d | 301 | @param[out] Buffer The pointer to buffer for file's information.\r |
302 | @param[out] NoFile The pointer to boolean when last file is found.\r | |
d2b4564b | 303 | \r |
a405b86d | 304 | @retval EFI_SUCCESS Found the next file, or reached last file.\r |
d2b4564b | 305 | @retval EFI_NO_MEDIA The device has no media.\r |
306 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
307 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
308 | **/\r | |
309 | EFI_STATUS\r | |
310 | EFIAPI\r | |
311 | FileHandleFindNextFile(\r | |
312 | IN EFI_FILE_HANDLE DirHandle,\r | |
313 | OUT EFI_FILE_INFO *Buffer,\r | |
314 | OUT BOOLEAN *NoFile\r | |
315 | );\r | |
316 | \r | |
317 | /**\r | |
318 | Retrieve the size of a file.\r | |
319 | \r | |
1e6e84c7 | 320 | This function extracts the file size info from the FileHandle's EFI_FILE_INFO\r |
d2b4564b | 321 | data.\r |
322 | \r | |
a405b86d | 323 | @param[in] FileHandle The file handle from which size is retrieved.\r |
324 | @param[out] Size The pointer to size.\r | |
d2b4564b | 325 | \r |
00b7cc0f | 326 | @retval EFI_SUCCESS Operation was completed successfully.\r |
a405b86d | 327 | @retval EFI_DEVICE_ERROR Cannot access the file.\r |
b269f895 QS |
328 | @retval EFI_INVALID_PARAMETER FileHandle is NULL.\r |
329 | Size is NULL.\r | |
d2b4564b | 330 | **/\r |
331 | EFI_STATUS\r | |
332 | EFIAPI\r | |
333 | FileHandleGetSize (\r | |
334 | IN EFI_FILE_HANDLE FileHandle,\r | |
335 | OUT UINT64 *Size\r | |
b1f95a06 | 336 | );\r |
337 | \r | |
a405b86d | 338 | /**\r |
339 | Set the size of a file.\r | |
340 | \r | |
a405b86d | 341 | This function changes the file size info from the FileHandle's EFI_FILE_INFO\r |
342 | data.\r | |
343 | \r | |
344 | @param[in] FileHandle The file handle whose size is to be changed.\r | |
345 | @param[in] Size The new size.\r | |
346 | \r | |
347 | @retval EFI_SUCCESS The operation completed successfully.\r | |
348 | @retval EFI_DEVICE_ERROR Cannot access the file.\r | |
b269f895 | 349 | @retval EFI_INVALID_PARAMETER FileHandle is NULL.\r |
a405b86d | 350 | **/\r |
351 | EFI_STATUS\r | |
352 | EFIAPI\r | |
353 | FileHandleSetSize (\r | |
354 | IN EFI_FILE_HANDLE FileHandle,\r | |
355 | IN UINT64 Size\r | |
356 | );\r | |
357 | \r | |
b1f95a06 | 358 | /**\r |
1e6e84c7 | 359 | Function to get a full filename given a EFI_FILE_HANDLE somewhere lower on the\r |
ad6f6f86 QS |
360 | directory 'stack'. If the file is a directory, then append the '\' char at the \r |
361 | end of name string. If it's not a directory, then the last '\' should not be \r | |
362 | added.\r | |
b1f95a06 | 363 | \r |
b1f95a06 | 364 | @param[in] Handle Handle to the Directory or File to create path to.\r |
1e6e84c7 | 365 | @param[out] FullFileName Pointer to pointer to generated full file name. It\r |
b1f95a06 | 366 | is the responsibility of the caller to free this memory\r |
367 | with a call to FreePool().\r | |
a405b86d | 368 | @retval EFI_SUCCESS The operation was successful and FullFileName is valid.\r |
b1f95a06 | 369 | @retval EFI_INVALID_PARAMETER Handle was NULL.\r |
370 | @retval EFI_INVALID_PARAMETER FullFileName was NULL.\r | |
a405b86d | 371 | @retval EFI_OUT_OF_MEMORY A memory allocation failed.\r |
b1f95a06 | 372 | **/\r |
373 | EFI_STATUS\r | |
374 | EFIAPI\r | |
375 | FileHandleGetFileName (\r | |
376 | IN CONST EFI_FILE_HANDLE Handle,\r | |
377 | OUT CHAR16 **FullFileName\r | |
378 | );\r | |
379 | \r | |
380 | /**\r | |
b3011f40 | 381 | Function to read a single line (up to but not including the \n) from a file.\r |
b1f95a06 | 382 | \r |
1e6e84c7 | 383 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r |
b3011f40 | 384 | maintained and not changed for all operations with the same file.\r |
ba180625 QS |
385 | The function will not return the \r and \n character in buffer. When an empty line is\r |
386 | read a CHAR_NULL character will be returned in buffer.\r | |
b3011f40 | 387 | \r |
4ff7e37b ED |
388 | @param[in] Handle FileHandle to read from.\r |
389 | @param[in, out] Buffer The pointer to buffer to read into.\r | |
390 | @param[in, out] Size The pointer to number of bytes in Buffer.\r | |
391 | @param[in] Truncate If the buffer is large enough, this has no effect.\r | |
392 | If the buffer is is too small and Truncate is TRUE,\r | |
393 | the line will be truncated.\r | |
394 | If the buffer is is too small and Truncate is FALSE,\r | |
395 | then no read will occur.\r | |
a405b86d | 396 | \r |
4ff7e37b ED |
397 | @param[in, out] Ascii Boolean value for indicating whether the file is\r |
398 | Ascii (TRUE) or UCS2 (FALSE).\r | |
b1f95a06 | 399 | \r |
a405b86d | 400 | @retval EFI_SUCCESS The operation was successful. The line is stored in\r |
b3011f40 | 401 | Buffer.\r |
b1f95a06 | 402 | @retval EFI_INVALID_PARAMETER Handle was NULL.\r |
b1f95a06 | 403 | @retval EFI_INVALID_PARAMETER Size was NULL.\r |
a405b86d | 404 | @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r |
405 | Size was updated to the minimum space required.\r | |
b1f95a06 | 406 | @sa FileHandleRead\r |
407 | **/\r | |
408 | EFI_STATUS\r | |
409 | EFIAPI\r | |
410 | FileHandleReadLine(\r | |
411 | IN EFI_FILE_HANDLE Handle,\r | |
125c2cf4 | 412 | IN OUT CHAR16 *Buffer,\r |
b1f95a06 | 413 | IN OUT UINTN *Size,\r |
b3011f40 | 414 | IN BOOLEAN Truncate,\r |
415 | IN OUT BOOLEAN *Ascii\r | |
416 | );\r | |
417 | \r | |
418 | /**\r | |
1e6e84c7 | 419 | Function to read a single line from a file. The \n is not included in the returned\r |
b3011f40 | 420 | buffer. The returned buffer must be callee freed.\r |
421 | \r | |
1e6e84c7 | 422 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r |
b3011f40 | 423 | maintained and not changed for all operations with the same file.\r |
424 | \r | |
4ff7e37b ED |
425 | @param[in] Handle FileHandle to read from.\r |
426 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
427 | Ascii (TRUE) or UCS2 (FALSE).\r | |
b3011f40 | 428 | \r |
429 | @return The line of text from the file.\r | |
430 | \r | |
431 | @sa FileHandleReadLine\r | |
432 | **/\r | |
433 | CHAR16*\r | |
434 | EFIAPI\r | |
435 | FileHandleReturnLine(\r | |
436 | IN EFI_FILE_HANDLE Handle,\r | |
437 | IN OUT BOOLEAN *Ascii\r | |
b1f95a06 | 438 | );\r |
439 | \r | |
440 | /**\r | |
a86c73cd QS |
441 | Function to write a line of text to a file.\r |
442 | \r | |
443 | If the file is a Unicode file (with UNICODE file tag) then write the unicode \r | |
444 | text.\r | |
445 | If the file is an ASCII file then write the ASCII text.\r | |
446 | If the size of file is zero (without file tag at the beginning) then write \r | |
447 | ASCII text as default.\r | |
b1f95a06 | 448 | \r |
a405b86d | 449 | @param[in] Handle FileHandle to write to.\r |
1e6e84c7 | 450 | @param[in] Buffer Buffer to write, if NULL the function will\r |
125c2cf4 | 451 | take no action and return EFI_SUCCESS.\r |
b1f95a06 | 452 | \r |
b269f895 QS |
453 | @retval EFI_SUCCESS The data was written.\r |
454 | Buffer is NULL.\r | |
455 | @retval EFI_INVALID_PARAMETER Handle is NULL.\r | |
a86c73cd QS |
456 | @retval EFI_OUT_OF_RESOURCES Unable to allocate temporary space for ASCII \r |
457 | string due to out of resources.\r | |
b1f95a06 | 458 | \r |
459 | @sa FileHandleWrite\r | |
460 | **/\r | |
461 | EFI_STATUS\r | |
462 | EFIAPI\r | |
463 | FileHandleWriteLine(\r | |
464 | IN EFI_FILE_HANDLE Handle,\r | |
465 | IN CHAR16 *Buffer\r | |
e9880e25 | 466 | );\r |
125c2cf4 | 467 | \r |
468 | /**\r | |
a405b86d | 469 | Function to take a formatted argument and print it to a file.\r |
125c2cf4 | 470 | \r |
a405b86d | 471 | @param[in] Handle The file handle for the file to write to.\r |
472 | @param[in] Format The format argument (see printlib for the format specifier).\r | |
473 | @param[in] ... The variable arguments for the format.\r | |
125c2cf4 | 474 | \r |
a405b86d | 475 | @retval EFI_SUCCESS The operation was successful.\r |
476 | @retval other A return value from FileHandleWriteLine.\r | |
125c2cf4 | 477 | \r |
478 | @sa FileHandleWriteLine\r | |
479 | **/\r | |
480 | EFI_STATUS\r | |
481 | EFIAPI\r | |
482 | FileHandlePrintLine(\r | |
483 | IN EFI_FILE_HANDLE Handle,\r | |
484 | IN CONST CHAR16 *Format,\r | |
485 | ...\r | |
486 | );\r | |
487 | \r | |
488 | /**\r | |
489 | Function to determine if a FILE_HANDLE is at the end of the file.\r | |
490 | \r | |
491 | This will NOT work on directories.\r | |
492 | \r | |
a405b86d | 493 | If Handle is NULL, then ASSERT().\r |
b3011f40 | 494 | \r |
a405b86d | 495 | @param[in] Handle The file handle.\r |
125c2cf4 | 496 | \r |
a405b86d | 497 | @retval TRUE The position is at the end of the file.\r |
498 | @retval FALSE The position is not at the end of the file.\r | |
125c2cf4 | 499 | **/\r |
500 | BOOLEAN\r | |
501 | EFIAPI\r | |
502 | FileHandleEof(\r | |
503 | IN EFI_FILE_HANDLE Handle\r | |
504 | );\r | |
b3011f40 | 505 | \r |
506 | #endif //_FILE_HANDLE_LIBRARY_HEADER_\r | |
507 | \r |