]>
Commit | Line | Data |
---|---|---|
94b17fa1 | 1 | /** @file\r |
2 | Provides interface to shell functionality for shell commands and applications.\r | |
3 | \r | |
4bbdc0e1 | 4 | Copyright (c) 2006 - 2011, 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 | |
94b17fa1 | 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 | |
94b17fa1 | 12 | \r |
13 | **/\r | |
14 | \r | |
a405b86d | 15 | #ifndef __SHELL_LIB__\r |
94b17fa1 | 16 | #define __SHELL_LIB__\r |
17 | \r | |
b3011f40 | 18 | #include <Uefi.h>\r |
19 | #include <Guid/FileInfo.h>\r | |
94b17fa1 | 20 | #include <Protocol/SimpleFileSystem.h>\r |
b3011f40 | 21 | #include <Protocol/LoadedImage.h>\r |
22 | #include <Protocol/EfiShellInterface.h>\r | |
23 | #include <Protocol/EfiShellEnvironment2.h>\r | |
94b17fa1 | 24 | #include <Protocol/EfiShell.h>\r |
b3011f40 | 25 | #include <Protocol/EfiShellParameters.h>\r |
94b17fa1 | 26 | \r |
a405b86d | 27 | // (20 * (6+5+2))+1) unicode characters from EFI FAT spec (doubled for bytes)\r |
28 | #define MAX_FILE_NAME_LEN 512\r | |
29 | \r | |
366f81a0 | 30 | extern EFI_SHELL_PARAMETERS_PROTOCOL *gEfiShellParametersProtocol;\r |
31 | extern EFI_SHELL_PROTOCOL *gEfiShellProtocol;\r | |
a405b86d | 32 | \r |
94b17fa1 | 33 | /**\r |
1e6e84c7 | 34 | This function will retrieve the information about the file for the handle\r |
94b17fa1 | 35 | specified and store it in allocated pool memory.\r |
36 | \r | |
1e6e84c7 | 37 | This function allocates a buffer to store the file's information. It is the\r |
18cefebe | 38 | caller's responsibility to free the buffer.\r |
94b17fa1 | 39 | \r |
1e6e84c7 | 40 | @param[in] FileHandle The file handle of the file for which information is\r |
18cefebe | 41 | being requested.\r |
94b17fa1 | 42 | \r |
18cefebe | 43 | @retval NULL Information could not be retrieved.\r |
94b17fa1 | 44 | \r |
18cefebe | 45 | @return The information about the file.\r |
94b17fa1 | 46 | **/\r |
47 | EFI_FILE_INFO*\r | |
48 | EFIAPI\r | |
49 | ShellGetFileInfo (\r | |
a405b86d | 50 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 51 | );\r |
52 | \r | |
53 | /**\r | |
a405b86d | 54 | This function sets the information about the file for the opened handle\r |
94b17fa1 | 55 | specified.\r |
56 | \r | |
1e6e84c7 | 57 | @param[in] FileHandle The file handle of the file for which information\r |
a5bd42b9 | 58 | is being set.\r |
94b17fa1 | 59 | \r |
a405b86d | 60 | @param[in] FileInfo The information to set.\r |
94b17fa1 | 61 | \r |
b0934ac4 | 62 | @retval EFI_SUCCESS The information was set.\r |
a405b86d | 63 | @retval EFI_INVALID_PARAMETER A parameter was out of range or invalid.\r |
64 | @retval EFI_UNSUPPORTED The FileHandle does not support FileInfo.\r | |
b0934ac4 | 65 | @retval EFI_NO_MEDIA The device has no medium.\r |
66 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
67 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
68 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
a405b86d | 69 | @retval EFI_ACCESS_DENIED The file was opened read only.\r |
70 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 71 | **/\r |
72 | EFI_STATUS\r | |
73 | EFIAPI\r | |
74 | ShellSetFileInfo (\r | |
b0934ac4 | 75 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 76 | IN EFI_FILE_INFO *FileInfo\r |
77 | );\r | |
78 | \r | |
79 | /**\r | |
80 | This function will open a file or directory referenced by DevicePath.\r | |
81 | \r | |
1e6e84c7 | 82 | This function opens a file with the open mode according to the file path. The\r |
94b17fa1 | 83 | Attributes is valid only for EFI_FILE_MODE_CREATE.\r |
84 | \r | |
4ff7e37b ED |
85 | @param[in, out] FilePath On input, the device path to the file. On output,\r |
86 | the remaining device path.\r | |
87 | @param[out] DeviceHandle Pointer to the system device handle.\r | |
88 | @param[out] FileHandle Pointer to the file handle.\r | |
89 | @param[in] OpenMode The mode to open the file with.\r | |
90 | @param[in] Attributes The file's file attributes.\r | |
94b17fa1 | 91 | \r |
b0934ac4 | 92 | @retval EFI_SUCCESS The information was set.\r |
93 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
a405b86d | 94 | @retval EFI_UNSUPPORTED Could not open the file path.\r |
b0934ac4 | 95 | @retval EFI_NOT_FOUND The specified file could not be found on the\r |
1e6e84c7 | 96 | device or the file system could not be found on\r |
94b17fa1 | 97 | the device.\r |
a405b86d | 98 | @retval EFI_NO_MEDIA The device has no medium.\r |
99 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 100 | medium is no longer supported.\r |
a405b86d | 101 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
b0934ac4 | 102 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
a405b86d | 103 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r |
104 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
b0934ac4 | 105 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r |
94b17fa1 | 106 | file.\r |
a405b86d | 107 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 108 | **/\r |
109 | EFI_STATUS\r | |
110 | EFIAPI\r | |
111 | ShellOpenFileByDevicePath(\r | |
b0934ac4 | 112 | IN OUT EFI_DEVICE_PATH_PROTOCOL **FilePath,\r |
113 | OUT EFI_HANDLE *DeviceHandle,\r | |
114 | OUT SHELL_FILE_HANDLE *FileHandle,\r | |
115 | IN UINT64 OpenMode,\r | |
116 | IN UINT64 Attributes\r | |
94b17fa1 | 117 | );\r |
118 | \r | |
119 | /**\r | |
120 | This function will open a file or directory referenced by filename.\r | |
121 | \r | |
1e6e84c7 | 122 | If return is EFI_SUCCESS, the Filehandle is the opened file's handle;\r |
a405b86d | 123 | otherwise, the Filehandle is NULL. Attributes is valid only for\r |
94b17fa1 | 124 | EFI_FILE_MODE_CREATE.\r |
125 | \r | |
a405b86d | 126 | @param[in] FilePath The pointer to file name.\r |
127 | @param[out] FileHandle The pointer to the file handle.\r | |
128 | @param[in] OpenMode The mode to open the file with.\r | |
129 | @param[in] Attributes The file's file attributes.\r | |
94b17fa1 | 130 | \r |
b0934ac4 | 131 | @retval EFI_SUCCESS The information was set.\r |
132 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
a405b86d | 133 | @retval EFI_UNSUPPORTED Could not open the file path.\r |
b0934ac4 | 134 | @retval EFI_NOT_FOUND The specified file could not be found on the\r |
1e6e84c7 | 135 | device or the file system could not be found\r |
94b17fa1 | 136 | on the device.\r |
a405b86d | 137 | @retval EFI_NO_MEDIA The device has no medium.\r |
138 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 139 | medium is no longer supported.\r |
a405b86d | 140 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
b0934ac4 | 141 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
a405b86d | 142 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r |
143 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
b0934ac4 | 144 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r |
94b17fa1 | 145 | file.\r |
a405b86d | 146 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 147 | **/\r |
148 | EFI_STATUS\r | |
149 | EFIAPI\r | |
150 | ShellOpenFileByName(\r | |
b0934ac4 | 151 | IN CONST CHAR16 *FilePath,\r |
a405b86d | 152 | OUT SHELL_FILE_HANDLE *FileHandle,\r |
94b17fa1 | 153 | IN UINT64 OpenMode,\r |
b0934ac4 | 154 | IN UINT64 Attributes\r |
94b17fa1 | 155 | );\r |
156 | \r | |
157 | /**\r | |
18cefebe | 158 | This function creates a directory.\r |
94b17fa1 | 159 | \r |
1e6e84c7 | 160 | If return is EFI_SUCCESS, the Filehandle is the opened directory's handle;\r |
161 | otherwise, the Filehandle is NULL. If the directory already existed, this\r | |
94b17fa1 | 162 | function opens the existing directory.\r |
163 | \r | |
a405b86d | 164 | @param[in] DirectoryName The pointer to Directory name.\r |
165 | @param[out] FileHandle The pointer to the file handle.\r | |
94b17fa1 | 166 | \r |
b0934ac4 | 167 | @retval EFI_SUCCESS The information was set.\r |
168 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
a405b86d | 169 | @retval EFI_UNSUPPORTED Could not open the file path.\r |
b0934ac4 | 170 | @retval EFI_NOT_FOUND The specified file could not be found on the\r |
a405b86d | 171 | device, or the file system could not be found\r |
94b17fa1 | 172 | on the device.\r |
a405b86d | 173 | @retval EFI_NO_MEDIA The device has no medium.\r |
174 | @retval EFI_MEDIA_CHANGED The device has a different medium in it or the\r | |
94b17fa1 | 175 | medium is no longer supported.\r |
a405b86d | 176 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
b0934ac4 | 177 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
a405b86d | 178 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r |
179 | @retval EFI_ACCESS_DENIED The file was opened read only.\r | |
b0934ac4 | 180 | @retval EFI_OUT_OF_RESOURCES Not enough resources were available to open the\r |
94b17fa1 | 181 | file.\r |
a405b86d | 182 | @retval EFI_VOLUME_FULL The volume is full.\r |
94b17fa1 | 183 | **/\r |
184 | EFI_STATUS\r | |
185 | EFIAPI\r | |
186 | ShellCreateDirectory(\r | |
b82bfcc1 | 187 | IN CONST CHAR16 *DirectoryName,\r |
a405b86d | 188 | OUT SHELL_FILE_HANDLE *FileHandle\r |
94b17fa1 | 189 | );\r |
190 | \r | |
191 | /**\r | |
192 | This function reads information from an opened file.\r | |
193 | \r | |
1e6e84c7 | 194 | If FileHandle is not a directory, the function reads the requested number of\r |
195 | bytes from the file at the file's current position and returns them in Buffer.\r | |
94b17fa1 | 196 | If the read goes beyond the end of the file, the read length is truncated to the\r |
1e6e84c7 | 197 | end of the file. The file's current position is increased by the number of bytes\r |
198 | returned. If FileHandle is a directory, the function reads the directory entry\r | |
199 | at the file's current position and returns the entry in Buffer. If the Buffer\r | |
200 | is not large enough to hold the current directory entry, then\r | |
201 | EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated.\r | |
202 | BufferSize is set to be the size of the buffer needed to read the entry. On\r | |
203 | success, the current position is updated to the next directory entry. If there\r | |
204 | are no more directory entries, the read returns a zero-length buffer.\r | |
94b17fa1 | 205 | EFI_FILE_INFO is the structure returned as the directory entry.\r |
206 | \r | |
4ff7e37b ED |
207 | @param[in] FileHandle The opened file handle.\r |
208 | @param[in, out] ReadSize On input the size of buffer in bytes. On return\r | |
209 | the number of bytes written.\r | |
210 | @param[out] Buffer The buffer to put read data into.\r | |
94b17fa1 | 211 | \r |
a405b86d | 212 | @retval EFI_SUCCESS Data was read.\r |
b0934ac4 | 213 | @retval EFI_NO_MEDIA The device has no media.\r |
a405b86d | 214 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
b0934ac4 | 215 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r |
a405b86d | 216 | @retval EFI_BUFFER_TO_SMALL Buffer is too small. ReadSize contains required\r |
94b17fa1 | 217 | size.\r |
218 | \r | |
219 | **/\r | |
220 | EFI_STATUS\r | |
221 | EFIAPI\r | |
222 | ShellReadFile(\r | |
a405b86d | 223 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 224 | IN OUT UINTN *ReadSize,\r |
225 | OUT VOID *Buffer\r | |
226 | );\r | |
227 | \r | |
228 | /**\r | |
229 | Write data to a file.\r | |
230 | \r | |
1e6e84c7 | 231 | This function writes the specified number of bytes to the file at the current\r |
232 | file position. The current file position is advanced the actual number of bytes\r | |
233 | written, which is returned in BufferSize. Partial writes only occur when there\r | |
234 | has been a data error during the write attempt (such as "volume space full").\r | |
235 | The file is automatically grown to hold the data if required. Direct writes to\r | |
94b17fa1 | 236 | opened directories are not supported.\r |
237 | \r | |
4ff7e37b | 238 | @param[in] FileHandle The opened file for writing.\r |
94b17fa1 | 239 | \r |
4ff7e37b ED |
240 | @param[in, out] BufferSize On input the number of bytes in Buffer. On output\r |
241 | the number of bytes written.\r | |
94b17fa1 | 242 | \r |
4ff7e37b | 243 | @param[in] Buffer The buffer containing data to write is stored.\r |
94b17fa1 | 244 | \r |
a405b86d | 245 | @retval EFI_SUCCESS Data was written.\r |
246 | @retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r | |
b0934ac4 | 247 | @retval EFI_NO_MEDIA The device has no media.\r |
a405b86d | 248 | @retval EFI_DEVICE_ERROR The device reported an error.\r |
249 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
250 | @retval EFI_WRITE_PROTECTED The device is write-protected.\r | |
251 | @retval EFI_ACCESS_DENIED The file was open for read only.\r | |
252 | @retval EFI_VOLUME_FULL The volume is full.\r | |
94b17fa1 | 253 | **/\r |
254 | EFI_STATUS\r | |
255 | EFIAPI\r | |
256 | ShellWriteFile(\r | |
a405b86d | 257 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 258 | IN OUT UINTN *BufferSize,\r |
08d7f8e8 | 259 | IN VOID *Buffer\r |
94b17fa1 | 260 | );\r |
261 | \r | |
1e6e84c7 | 262 | /**\r |
94b17fa1 | 263 | Close an open file handle.\r |
264 | \r | |
1e6e84c7 | 265 | This function closes a specified file handle. All "dirty" cached file data is\r |
266 | flushed to the device, and the file is closed. In all cases the handle is\r | |
94b17fa1 | 267 | closed.\r |
268 | \r | |
18cefebe | 269 | @param[in] FileHandle The file handle to close.\r |
94b17fa1 | 270 | \r |
125c2cf4 | 271 | @retval EFI_SUCCESS The file handle was closed sucessfully.\r |
a405b86d | 272 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
94b17fa1 | 273 | **/\r |
274 | EFI_STATUS\r | |
275 | EFIAPI\r | |
276 | ShellCloseFile (\r | |
a405b86d | 277 | IN SHELL_FILE_HANDLE *FileHandle\r |
94b17fa1 | 278 | );\r |
279 | \r | |
280 | /**\r | |
281 | Delete a file and close the handle\r | |
282 | \r | |
283 | This function closes and deletes a file. In all cases the file handle is closed.\r | |
1e6e84c7 | 284 | If the file cannot be deleted, the warning code EFI_WARN_DELETE_FAILURE is\r |
94b17fa1 | 285 | returned, but the handle is still closed.\r |
286 | \r | |
18cefebe | 287 | @param[in] FileHandle The file handle to delete.\r |
94b17fa1 | 288 | \r |
125c2cf4 | 289 | @retval EFI_SUCCESS The file was closed sucessfully.\r |
1e6e84c7 | 290 | @retval EFI_WARN_DELETE_FAILURE The handle was closed, but the file was not\r |
125c2cf4 | 291 | deleted.\r |
b0934ac4 | 292 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
94b17fa1 | 293 | **/\r |
294 | EFI_STATUS\r | |
295 | EFIAPI\r | |
296 | ShellDeleteFile (\r | |
a405b86d | 297 | IN SHELL_FILE_HANDLE *FileHandle\r |
94b17fa1 | 298 | );\r |
299 | \r | |
300 | /**\r | |
301 | Set the current position in a file.\r | |
302 | \r | |
1e6e84c7 | 303 | This function sets the current file position for the handle to the position\r |
94b17fa1 | 304 | supplied. With the exception of seeking to position 0xFFFFFFFFFFFFFFFF, only\r |
a405b86d | 305 | absolute positioning is supported, and moving past the end of the file is\r |
306 | allowed (a subsequent write would grow the file). Moving to position\r | |
94b17fa1 | 307 | 0xFFFFFFFFFFFFFFFF causes the current position to be set to the end of the file.\r |
1e6e84c7 | 308 | If FileHandle is a directory, the only position that may be set is zero. This\r |
94b17fa1 | 309 | has the effect of starting the read process of the directory entries over.\r |
310 | \r | |
18cefebe | 311 | @param[in] FileHandle The file handle on which the position is being set.\r |
94b17fa1 | 312 | \r |
a405b86d | 313 | @param[in] Position The byte position from the begining of the file.\r |
94b17fa1 | 314 | \r |
315 | @retval EFI_SUCCESS Operation completed sucessfully.\r | |
1e6e84c7 | 316 | @retval EFI_UNSUPPORTED The seek request for non-zero is not valid on\r |
94b17fa1 | 317 | directories.\r |
318 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r | |
319 | **/\r | |
320 | EFI_STATUS\r | |
321 | EFIAPI\r | |
322 | ShellSetFilePosition (\r | |
b0934ac4 | 323 | IN SHELL_FILE_HANDLE FileHandle,\r |
324 | IN UINT64 Position\r | |
94b17fa1 | 325 | );\r |
326 | \r | |
1e6e84c7 | 327 | /**\r |
94b17fa1 | 328 | Gets a file's current position\r |
329 | \r | |
1e6e84c7 | 330 | This function retrieves the current file position for the file handle. For\r |
331 | directories, the current file position has no meaning outside of the file\r | |
94b17fa1 | 332 | system driver and as such the operation is not supported. An error is returned\r |
333 | if FileHandle is a directory.\r | |
334 | \r | |
18cefebe | 335 | @param[in] FileHandle The open file handle on which to get the position.\r |
a405b86d | 336 | @param[out] Position The byte position from the begining of the file.\r |
94b17fa1 | 337 | \r |
18cefebe | 338 | @retval EFI_SUCCESS The operation completed sucessfully.\r |
94b17fa1 | 339 | @retval INVALID_PARAMETER One of the parameters has an invalid value.\r |
18cefebe | 340 | @retval EFI_UNSUPPORTED The request is not valid on directories.\r |
94b17fa1 | 341 | **/\r |
342 | EFI_STATUS\r | |
343 | EFIAPI\r | |
344 | ShellGetFilePosition (\r | |
a405b86d | 345 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 346 | OUT UINT64 *Position\r |
347 | );\r | |
348 | \r | |
349 | /**\r | |
350 | Flushes data on a file\r | |
1e6e84c7 | 351 | \r |
94b17fa1 | 352 | This function flushes all modified data associated with a file to a device.\r |
353 | \r | |
18cefebe | 354 | @param[in] FileHandle The file handle on which to flush data.\r |
94b17fa1 | 355 | \r |
356 | @retval EFI_SUCCESS The data was flushed.\r | |
357 | @retval EFI_NO_MEDIA The device has no media.\r | |
358 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
359 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
360 | @retval EFI_WRITE_PROTECTED The file or medium is write protected.\r | |
361 | @retval EFI_ACCESS_DENIED The file was opened for read only.\r | |
362 | **/\r | |
363 | EFI_STATUS\r | |
364 | EFIAPI\r | |
365 | ShellFlushFile (\r | |
a405b86d | 366 | IN SHELL_FILE_HANDLE FileHandle\r |
94b17fa1 | 367 | );\r |
368 | \r | |
b0934ac4 | 369 | /** Retrieve first entry from a directory.\r |
94b17fa1 | 370 | \r |
b0934ac4 | 371 | This function takes an open directory handle and gets information from the\r |
372 | first entry in the directory. A buffer is allocated to contain\r | |
373 | the information and a pointer to the buffer is returned in *Buffer. The\r | |
374 | caller can use ShellFindNextFile() to get subsequent directory entries.\r | |
94b17fa1 | 375 | \r |
b0934ac4 | 376 | The buffer will be freed by ShellFindNextFile() when the last directory\r |
377 | entry is read. Otherwise, the caller must free the buffer, using FreePool,\r | |
378 | when finished with it.\r | |
d2b4564b | 379 | \r |
b0934ac4 | 380 | @param[in] DirHandle The file handle of the directory to search.\r |
a405b86d | 381 | @param[out] Buffer The pointer to the buffer for the file's information.\r |
94b17fa1 | 382 | \r |
383 | @retval EFI_SUCCESS Found the first file.\r | |
384 | @retval EFI_NOT_FOUND Cannot find the directory.\r | |
385 | @retval EFI_NO_MEDIA The device has no media.\r | |
386 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
387 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
b0934ac4 | 388 | @return Others Status of ShellGetFileInfo, ShellSetFilePosition,\r |
389 | or ShellReadFile.\r | |
390 | \r | |
a405b86d | 391 | @sa ShellReadFile\r |
94b17fa1 | 392 | **/\r |
393 | EFI_STATUS\r | |
394 | EFIAPI\r | |
395 | ShellFindFirstFile (\r | |
b0934ac4 | 396 | IN SHELL_FILE_HANDLE DirHandle,\r |
397 | OUT EFI_FILE_INFO **Buffer\r | |
94b17fa1 | 398 | );\r |
399 | \r | |
b0934ac4 | 400 | /** Retrieve next entries from a directory.\r |
94b17fa1 | 401 | \r |
b0934ac4 | 402 | To use this function, the caller must first call the ShellFindFirstFile()\r |
403 | function to get the first directory entry. Subsequent directory entries are\r | |
404 | retrieved by using the ShellFindNextFile() function. This function can\r | |
405 | be called several times to get each entry from the directory. If the call of\r | |
406 | ShellFindNextFile() retrieved the last directory entry, the next call of\r | |
407 | this function will set *NoFile to TRUE and free the buffer.\r | |
94b17fa1 | 408 | \r |
b0934ac4 | 409 | @param[in] DirHandle The file handle of the directory.\r |
37d5c6ee ED |
410 | @param[in, out] Buffer The pointer to buffer for file's information.\r |
411 | @param[in, out] NoFile The pointer to boolean when last file is found.\r | |
94b17fa1 | 412 | \r |
413 | @retval EFI_SUCCESS Found the next file.\r | |
414 | @retval EFI_NO_MEDIA The device has no media.\r | |
415 | @retval EFI_DEVICE_ERROR The device reported an error.\r | |
416 | @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r | |
b0934ac4 | 417 | \r |
a405b86d | 418 | @sa ShellReadFile\r |
94b17fa1 | 419 | **/\r |
420 | EFI_STATUS\r | |
421 | EFIAPI\r | |
422 | ShellFindNextFile(\r | |
b0934ac4 | 423 | IN SHELL_FILE_HANDLE DirHandle,\r |
424 | IN OUT EFI_FILE_INFO *Buffer,\r | |
425 | IN OUT BOOLEAN *NoFile\r | |
94b17fa1 | 426 | );\r |
427 | \r | |
428 | /**\r | |
429 | Retrieve the size of a file.\r | |
430 | \r | |
1e6e84c7 | 431 | This function extracts the file size info from the FileHandle's EFI_FILE_INFO\r |
94b17fa1 | 432 | data.\r |
433 | \r | |
18cefebe | 434 | @param[in] FileHandle The file handle from which size is retrieved.\r |
a405b86d | 435 | @param[out] Size The pointer to size.\r |
94b17fa1 | 436 | \r |
125c2cf4 | 437 | @retval EFI_SUCCESS The operation was completed sucessfully.\r |
a31bd33c | 438 | @retval EFI_DEVICE_ERROR Cannot access the file.\r |
94b17fa1 | 439 | **/\r |
440 | EFI_STATUS\r | |
441 | EFIAPI\r | |
442 | ShellGetFileSize (\r | |
a405b86d | 443 | IN SHELL_FILE_HANDLE FileHandle,\r |
94b17fa1 | 444 | OUT UINT64 *Size\r |
445 | );\r | |
446 | \r | |
447 | /**\r | |
448 | Retrieves the status of the break execution flag\r | |
449 | \r | |
18cefebe | 450 | This function is useful to check whether the application is being asked to halt by the shell.\r |
94b17fa1 | 451 | \r |
a405b86d | 452 | @retval TRUE The execution break is enabled.\r |
453 | @retval FALSE The execution break is not enabled.\r | |
94b17fa1 | 454 | **/\r |
455 | BOOLEAN\r | |
456 | EFIAPI\r | |
457 | ShellGetExecutionBreakFlag(\r | |
458 | VOID\r | |
459 | );\r | |
460 | \r | |
461 | /**\r | |
125c2cf4 | 462 | Return the value of an environment variable.\r |
94b17fa1 | 463 | \r |
1e6e84c7 | 464 | This function gets the value of the environment variable set by the\r |
125c2cf4 | 465 | ShellSetEnvironmentVariable function.\r |
94b17fa1 | 466 | \r |
18cefebe | 467 | @param[in] EnvKey The key name of the environment variable.\r |
94b17fa1 | 468 | \r |
a31bd33c | 469 | @retval NULL The named environment variable does not exist.\r |
a405b86d | 470 | @return != NULL The pointer to the value of the environment variable.\r |
94b17fa1 | 471 | **/\r |
472 | CONST CHAR16*\r | |
473 | EFIAPI\r | |
474 | ShellGetEnvironmentVariable (\r | |
9b3bf083 | 475 | IN CONST CHAR16 *EnvKey\r |
94b17fa1 | 476 | );\r |
477 | \r | |
478 | /**\r | |
18cefebe | 479 | Set the value of an environment variable.\r |
94b17fa1 | 480 | \r |
125c2cf4 | 481 | This function changes the current value of the specified environment variable. If the\r |
482 | environment variable exists and the Value is an empty string, then the environment\r | |
483 | variable is deleted. If the environment variable exists and the Value is not an empty\r | |
484 | string, then the value of the environment variable is changed. If the environment\r | |
485 | variable does not exist and the Value is an empty string, there is no action. If the\r | |
486 | environment variable does not exist and the Value is a non-empty string, then the\r | |
487 | environment variable is created and assigned the specified value.\r | |
94b17fa1 | 488 | \r |
489 | This is not supported pre-UEFI Shell 2.0.\r | |
490 | \r | |
18cefebe | 491 | @param[in] EnvKey The key name of the environment variable.\r |
492 | @param[in] EnvVal The Value of the environment variable\r | |
493 | @param[in] Volatile Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r | |
94b17fa1 | 494 | \r |
a405b86d | 495 | @retval EFI_SUCCESS The operation completed sucessfully\r |
496 | @retval EFI_UNSUPPORTED This operation is not allowed in pre-UEFI 2.0 Shell environments.\r | |
94b17fa1 | 497 | **/\r |
498 | EFI_STATUS\r | |
499 | EFIAPI\r | |
500 | ShellSetEnvironmentVariable (\r | |
501 | IN CONST CHAR16 *EnvKey,\r | |
502 | IN CONST CHAR16 *EnvVal,\r | |
503 | IN BOOLEAN Volatile\r | |
504 | );\r | |
505 | \r | |
506 | /**\r | |
125c2cf4 | 507 | Cause the shell to parse and execute a command line.\r |
94b17fa1 | 508 | \r |
509 | This function creates a nested instance of the shell and executes the specified\r | |
125c2cf4 | 510 | command (CommandLine) with the specified environment (Environment). Upon return,\r |
511 | the status code returned by the specified command is placed in StatusCode.\r | |
512 | If Environment is NULL, then the current environment is used and all changes made\r | |
513 | by the commands executed will be reflected in the current environment. If the\r | |
514 | Environment is non-NULL, then the changes made will be discarded.\r | |
515 | The CommandLine is executed from the current working directory on the current\r | |
516 | device.\r | |
94b17fa1 | 517 | \r |
7e4ed4b8 | 518 | The EnvironmentVariables and Status parameters are ignored in a pre-UEFI Shell 2.0\r |
519 | environment. The values pointed to by the parameters will be unchanged by the\r | |
520 | ShellExecute() function. The Output parameter has no effect in a\r | |
521 | UEFI Shell 2.0 environment.\r | |
94b17fa1 | 522 | \r |
a405b86d | 523 | @param[in] ParentHandle The parent image starting the operation.\r |
524 | @param[in] CommandLine The pointer to a NULL terminated command line.\r | |
18cefebe | 525 | @param[in] Output True to display debug output. False to hide it.\r |
526 | @param[in] EnvironmentVariables Optional pointer to array of environment variables\r | |
a405b86d | 527 | in the form "x=y". If NULL, the current set is used.\r |
18cefebe | 528 | @param[out] Status The status of the run command line.\r |
94b17fa1 | 529 | \r |
18cefebe | 530 | @retval EFI_SUCCESS The operation completed sucessfully. Status\r |
531 | contains the status code returned.\r | |
532 | @retval EFI_INVALID_PARAMETER A parameter contains an invalid value.\r | |
533 | @retval EFI_OUT_OF_RESOURCES Out of resources.\r | |
534 | @retval EFI_UNSUPPORTED The operation is not allowed.\r | |
94b17fa1 | 535 | **/\r |
536 | EFI_STATUS\r | |
537 | EFIAPI\r | |
538 | ShellExecute (\r | |
539 | IN EFI_HANDLE *ParentHandle,\r | |
540 | IN CHAR16 *CommandLine,\r | |
541 | IN BOOLEAN Output,\r | |
542 | IN CHAR16 **EnvironmentVariables,\r | |
543 | OUT EFI_STATUS *Status\r | |
544 | );\r | |
545 | \r | |
546 | /**\r | |
a31bd33c | 547 | Retreives the current directory path.\r |
94b17fa1 | 548 | \r |
1e6e84c7 | 549 | If the DeviceName is NULL, it returns the current device's current directory\r |
550 | name. If the DeviceName is not NULL, it returns the current directory name\r | |
94b17fa1 | 551 | on specified drive.\r |
552 | \r | |
18cefebe | 553 | @param[in] DeviceName The name of the file system to get directory on.\r |
94b17fa1 | 554 | \r |
a31bd33c | 555 | @retval NULL The directory does not exist.\r |
18cefebe | 556 | @retval != NULL The directory.\r |
94b17fa1 | 557 | **/\r |
558 | CONST CHAR16*\r | |
559 | EFIAPI\r | |
560 | ShellGetCurrentDir (\r | |
a405b86d | 561 | IN CHAR16 * CONST DeviceName OPTIONAL\r |
94b17fa1 | 562 | );\r |
563 | \r | |
564 | /**\r | |
125c2cf4 | 565 | Sets (enabled or disabled) the page break mode.\r |
94b17fa1 | 566 | \r |
1e6e84c7 | 567 | When page break mode is enabled the screen will stop scrolling\r |
94b17fa1 | 568 | and wait for operator input before scrolling a subsequent screen.\r |
569 | \r | |
18cefebe | 570 | @param[in] CurrentState TRUE to enable and FALSE to disable.\r |
94b17fa1 | 571 | **/\r |
1e6e84c7 | 572 | VOID\r |
94b17fa1 | 573 | EFIAPI\r |
574 | ShellSetPageBreakMode (\r | |
575 | IN BOOLEAN CurrentState\r | |
576 | );\r | |
577 | \r | |
578 | /**\r | |
579 | Opens a group of files based on a path.\r | |
580 | \r | |
1e6e84c7 | 581 | This function uses the Arg to open all the matching files. Each matched\r |
582 | file has a SHELL_FILE_ARG structure to record the file information. These\r | |
583 | structures are placed on the list ListHead. Users can get the SHELL_FILE_ARG\r | |
94b17fa1 | 584 | structures from ListHead to access each file. This function supports wildcards\r |
1e6e84c7 | 585 | and will process '?' and '*' as such. The list must be freed with a call to\r |
94b17fa1 | 586 | ShellCloseFileMetaArg().\r |
587 | \r | |
1e6e84c7 | 588 | If you are NOT appending to an existing list *ListHead must be NULL. If\r |
eb646684 | 589 | *ListHead is NULL then it must be callee freed.\r |
94b17fa1 | 590 | \r |
4ff7e37b ED |
591 | @param[in] Arg The pointer to path string.\r |
592 | @param[in] OpenMode Mode to open files with.\r | |
593 | @param[in, out] ListHead Head of linked list of results.\r | |
94b17fa1 | 594 | \r |
1e6e84c7 | 595 | @retval EFI_SUCCESS The operation was sucessful and the list head\r |
125c2cf4 | 596 | contains the list of opened files.\r |
a31bd33c | 597 | @retval != EFI_SUCCESS The operation failed.\r |
94b17fa1 | 598 | \r |
599 | @sa InternalShellConvertFileListType\r | |
600 | **/\r | |
601 | EFI_STATUS\r | |
602 | EFIAPI\r | |
603 | ShellOpenFileMetaArg (\r | |
604 | IN CHAR16 *Arg,\r | |
605 | IN UINT64 OpenMode,\r | |
606 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
607 | );\r | |
608 | \r | |
609 | /**\r | |
a31bd33c | 610 | Free the linked list returned from ShellOpenFileMetaArg.\r |
94b17fa1 | 611 | \r |
4ff7e37b | 612 | @param[in, out] ListHead The pointer to free.\r |
94b17fa1 | 613 | \r |
a31bd33c | 614 | @retval EFI_SUCCESS The operation was sucessful.\r |
615 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
94b17fa1 | 616 | **/\r |
617 | EFI_STATUS\r | |
618 | EFIAPI\r | |
619 | ShellCloseFileMetaArg (\r | |
620 | IN OUT EFI_SHELL_FILE_INFO **ListHead\r | |
621 | );\r | |
622 | \r | |
125c2cf4 | 623 | /**\r |
624 | Find a file by searching the CWD and then the path.\r | |
625 | \r | |
a31bd33c | 626 | If FileName is NULL, then ASSERT.\r |
125c2cf4 | 627 | \r |
a31bd33c | 628 | If the return value is not NULL then the memory must be caller freed.\r |
125c2cf4 | 629 | \r |
18cefebe | 630 | @param[in] FileName Filename string.\r |
125c2cf4 | 631 | \r |
a31bd33c | 632 | @retval NULL The file was not found.\r |
18cefebe | 633 | @retval !NULL The path to the file.\r |
125c2cf4 | 634 | **/\r |
635 | CHAR16 *\r | |
636 | EFIAPI\r | |
637 | ShellFindFilePath (\r | |
638 | IN CONST CHAR16 *FileName\r | |
639 | );\r | |
640 | \r | |
b3011f40 | 641 | /**\r |
1e6e84c7 | 642 | Find a file by searching the CWD and then the path with a variable set of file\r |
643 | extensions. If the file is not found it will append each extension in the list\r | |
b3011f40 | 644 | in the order provided and return the first one that is successful.\r |
645 | \r | |
646 | If FileName is NULL, then ASSERT.\r | |
a405b86d | 647 | If FileExtension is NULL, then the behavior is identical to ShellFindFilePath.\r |
b3011f40 | 648 | \r |
649 | If the return value is not NULL then the memory must be caller freed.\r | |
650 | \r | |
a405b86d | 651 | @param[in] FileName The filename string.\r |
652 | @param[in] FileExtension Semicolon delimited list of possible extensions.\r | |
b3011f40 | 653 | \r |
654 | @retval NULL The file was not found.\r | |
655 | @retval !NULL The path to the file.\r | |
656 | **/\r | |
657 | CHAR16 *\r | |
658 | EFIAPI\r | |
659 | ShellFindFilePathEx (\r | |
660 | IN CONST CHAR16 *FileName,\r | |
661 | IN CONST CHAR16 *FileExtension\r | |
662 | );\r | |
663 | \r | |
94b17fa1 | 664 | typedef enum {\r |
18cefebe | 665 | TypeFlag = 0, ///< A flag that is present or not present only (IE "-a").\r |
666 | TypeValue, ///< A flag that has some data following it with a space (IE "-a 1").\r | |
667 | TypePosition, ///< Some data that did not follow a parameter (IE "filename.txt").\r | |
668 | TypeStart, ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).\r | |
669 | TypeDoubleValue, ///< A flag that has 2 space seperated value data following it (IE "-a 1 2").\r | |
670 | TypeMaxValue, ///< A flag followed by all the command line data before the next flag.\r | |
94b17fa1 | 671 | TypeMax,\r |
a405b86d | 672 | } SHELL_PARAM_TYPE;\r |
94b17fa1 | 673 | \r |
674 | typedef struct {\r | |
a405b86d | 675 | CHAR16 *Name;\r |
676 | SHELL_PARAM_TYPE Type;\r | |
94b17fa1 | 677 | } SHELL_PARAM_ITEM;\r |
678 | \r | |
d2b4564b | 679 | \r |
680 | /// Helper structure for no parameters (besides -? and -b)\r | |
681 | extern SHELL_PARAM_ITEM EmptyParamList[];\r | |
682 | \r | |
a405b86d | 683 | /// Helper structure for -sfo only (besides -? and -b)\r |
684 | extern SHELL_PARAM_ITEM SfoParamList[];\r | |
685 | \r | |
94b17fa1 | 686 | /**\r |
1e6e84c7 | 687 | Checks the command line arguments passed against the list of valid ones.\r |
94b17fa1 | 688 | Optionally removes NULL values first.\r |
1e6e84c7 | 689 | \r |
94b17fa1 | 690 | If no initialization is required, then return RETURN_SUCCESS.\r |
1e6e84c7 | 691 | \r |
a405b86d | 692 | @param[in] CheckList The pointer to list of parameters to check.\r |
693 | @param[out] CheckPackage The package of checked values.\r | |
1e6e84c7 | 694 | @param[out] ProblemParam Optional pointer to pointer to unicode string for\r |
94b17fa1 | 695 | the paramater that caused failure.\r |
18cefebe | 696 | @param[in] AutoPageBreak Will automatically set PageBreakEnabled.\r |
697 | @param[in] AlwaysAllowNumbers Will never fail for number based flags.\r | |
94b17fa1 | 698 | \r |
699 | @retval EFI_SUCCESS The operation completed sucessfully.\r | |
a31bd33c | 700 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
701 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
a405b86d | 702 | @retval EFI_VOLUME_CORRUPTED The command line was corrupt.\r |
a31bd33c | 703 | @retval EFI_DEVICE_ERROR The commands contained 2 opposing arguments. One\r |
1e6e84c7 | 704 | of the command line arguments was returned in\r |
94b17fa1 | 705 | ProblemParam if provided.\r |
1e6e84c7 | 706 | @retval EFI_NOT_FOUND A argument required a value that was missing.\r |
a31bd33c | 707 | The invalid command line argument was returned in\r |
94b17fa1 | 708 | ProblemParam if provided.\r |
709 | **/\r | |
710 | EFI_STATUS\r | |
711 | EFIAPI\r | |
2247dde4 | 712 | ShellCommandLineParseEx (\r |
94b17fa1 | 713 | IN CONST SHELL_PARAM_ITEM *CheckList,\r |
714 | OUT LIST_ENTRY **CheckPackage,\r | |
715 | OUT CHAR16 **ProblemParam OPTIONAL,\r | |
2247dde4 | 716 | IN BOOLEAN AutoPageBreak,\r |
717 | IN BOOLEAN AlwaysAllowNumbers\r | |
94b17fa1 | 718 | );\r |
719 | \r | |
18cefebe | 720 | /// Make it easy to upgrade from older versions of the shell library.\r |
2247dde4 | 721 | #define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)\r |
722 | \r | |
94b17fa1 | 723 | /**\r |
724 | Frees shell variable list that was returned from ShellCommandLineParse.\r | |
725 | \r | |
726 | This function will free all the memory that was used for the CheckPackage\r | |
727 | list of postprocessed shell arguments.\r | |
728 | \r | |
a31bd33c | 729 | If CheckPackage is NULL, then return.\r |
94b17fa1 | 730 | \r |
18cefebe | 731 | @param[in] CheckPackage The list to de-allocate.\r |
94b17fa1 | 732 | **/\r |
733 | VOID\r | |
734 | EFIAPI\r | |
735 | ShellCommandLineFreeVarList (\r | |
736 | IN LIST_ENTRY *CheckPackage\r | |
737 | );\r | |
738 | \r | |
739 | /**\r | |
a31bd33c | 740 | Checks for presence of a flag parameter.\r |
94b17fa1 | 741 | \r |
18cefebe | 742 | Flag arguments are in the form of "-<Key>" or "/<Key>", but do not have a value following the key.\r |
94b17fa1 | 743 | \r |
18cefebe | 744 | If CheckPackage is NULL then return FALSE.\r |
745 | If KeyString is NULL then ASSERT().\r | |
1e6e84c7 | 746 | \r |
18cefebe | 747 | @param[in] CheckPackage The package of parsed command line arguments.\r |
748 | @param[in] KeyString The Key of the command line argument to check for.\r | |
94b17fa1 | 749 | \r |
a31bd33c | 750 | @retval TRUE The flag is on the command line.\r |
751 | @retval FALSE The flag is not on the command line.\r | |
a405b86d | 752 | **/\r |
94b17fa1 | 753 | BOOLEAN\r |
754 | EFIAPI\r | |
755 | ShellCommandLineGetFlag (\r | |
a405b86d | 756 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
757 | IN CONST CHAR16 * CONST KeyString\r | |
94b17fa1 | 758 | );\r |
759 | \r | |
760 | /**\r | |
a31bd33c | 761 | Returns value from command line argument.\r |
94b17fa1 | 762 | \r |
18cefebe | 763 | Value parameters are in the form of "-<Key> value" or "/<Key> value".\r |
1e6e84c7 | 764 | \r |
a31bd33c | 765 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 766 | \r |
36a9d672 | 767 | @param[in] CheckPackage The package of parsed command line arguments.\r |
768 | @param[in] KeyString The Key of the command line argument to check for.\r | |
94b17fa1 | 769 | \r |
a31bd33c | 770 | @retval NULL The flag is not on the command line.\r |
a405b86d | 771 | @retval !=NULL The pointer to unicode string of the value.\r |
772 | **/\r | |
94b17fa1 | 773 | CONST CHAR16*\r |
774 | EFIAPI\r | |
775 | ShellCommandLineGetValue (\r | |
776 | IN CONST LIST_ENTRY *CheckPackage,\r | |
777 | IN CHAR16 *KeyString\r | |
778 | );\r | |
779 | \r | |
780 | /**\r | |
a31bd33c | 781 | Returns raw value from command line argument.\r |
94b17fa1 | 782 | \r |
a31bd33c | 783 | Raw value parameters are in the form of "value" in a specific position in the list.\r |
1e6e84c7 | 784 | \r |
36a9d672 | 785 | If CheckPackage is NULL, then return NULL.\r |
94b17fa1 | 786 | \r |
36a9d672 | 787 | @param[in] CheckPackage The package of parsed command line arguments.\r |
788 | @param[in] Position The position of the value.\r | |
94b17fa1 | 789 | \r |
a31bd33c | 790 | @retval NULL The flag is not on the command line.\r |
a405b86d | 791 | @retval !=NULL The pointer to unicode string of the value.\r |
792 | **/\r | |
94b17fa1 | 793 | CONST CHAR16*\r |
794 | EFIAPI\r | |
795 | ShellCommandLineGetRawValue (\r | |
a405b86d | 796 | IN CONST LIST_ENTRY * CONST CheckPackage,\r |
797 | IN UINTN Position\r | |
94b17fa1 | 798 | );\r |
799 | \r | |
2247dde4 | 800 | /**\r |
1e6e84c7 | 801 | Returns the number of command line value parameters that were parsed.\r |
802 | \r | |
a31bd33c | 803 | This will not include flags.\r |
2247dde4 | 804 | \r |
a405b86d | 805 | @param[in] CheckPackage The package of parsed command line arguments.\r |
806 | \r | |
807 | @retval (UINTN)-1 No parsing has occurred.\r | |
808 | @retval other The number of value parameters found.\r | |
2247dde4 | 809 | **/\r |
810 | UINTN\r | |
811 | EFIAPI\r | |
812 | ShellCommandLineGetCount(\r | |
a405b86d | 813 | IN CONST LIST_ENTRY *CheckPackage\r |
2247dde4 | 814 | );\r |
815 | \r | |
36a9d672 | 816 | /**\r |
a405b86d | 817 | Determines if a parameter is duplicated.\r |
36a9d672 | 818 | \r |
a405b86d | 819 | If Param is not NULL, then it will point to a callee-allocated string buffer\r |
820 | with the parameter value, if a duplicate is found.\r | |
36a9d672 | 821 | \r |
822 | If CheckPackage is NULL, then ASSERT.\r | |
823 | \r | |
824 | @param[in] CheckPackage The package of parsed command line arguments.\r | |
825 | @param[out] Param Upon finding one, a pointer to the duplicated parameter.\r | |
826 | \r | |
827 | @retval EFI_SUCCESS No parameters were duplicated.\r | |
828 | @retval EFI_DEVICE_ERROR A duplicate was found.\r | |
829 | **/\r | |
830 | EFI_STATUS\r | |
831 | EFIAPI\r | |
832 | ShellCommandLineCheckDuplicate (\r | |
833 | IN CONST LIST_ENTRY *CheckPackage,\r | |
834 | OUT CHAR16 **Param\r | |
835 | );\r | |
836 | \r | |
d2b4564b | 837 | /**\r |
838 | This function causes the shell library to initialize itself. If the shell library\r | |
a405b86d | 839 | is already initialized it will de-initialize all the current protocol pointers and\r |
d2b4564b | 840 | re-populate them again.\r |
841 | \r | |
842 | When the library is used with PcdShellLibAutoInitialize set to true this function\r | |
843 | will return EFI_SUCCESS and perform no actions.\r | |
844 | \r | |
845 | This function is intended for internal access for shell commands only.\r | |
846 | \r | |
a405b86d | 847 | @retval EFI_SUCCESS The initialization was complete sucessfully.\r |
d2b4564b | 848 | \r |
849 | **/\r | |
850 | EFI_STATUS\r | |
851 | EFIAPI\r | |
852 | ShellInitialize (\r | |
125c2cf4 | 853 | VOID\r |
d2b4564b | 854 | );\r |
855 | \r | |
b1f95a06 | 856 | /**\r |
857 | Print at a specific location on the screen.\r | |
858 | \r | |
a5bd42b9 | 859 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 860 | \r |
861 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
a5bd42b9 | 862 | will be used.\r |
b1f95a06 | 863 | \r |
a31bd33c | 864 | If either Row or Col is out of range for the current console, then ASSERT.\r |
865 | If Format is NULL, then ASSERT.\r | |
b1f95a06 | 866 | \r |
1e6e84c7 | 867 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
b1f95a06 | 868 | the following additional flags:\r |
869 | %N - Set output attribute to normal\r | |
870 | %H - Set output attribute to highlight\r | |
871 | %E - Set output attribute to error\r | |
872 | %B - Set output attribute to blue color\r | |
873 | %V - Set output attribute to green color\r | |
874 | \r | |
875 | Note: The background color is controlled by the shell command cls.\r | |
876 | \r | |
18cefebe | 877 | @param[in] Col The column to print at.\r |
a405b86d | 878 | @param[in] Row The row to print at.\r |
18cefebe | 879 | @param[in] Format The format string.\r |
a405b86d | 880 | @param[in] ... The variable argument list.\r |
b1f95a06 | 881 | \r |
a405b86d | 882 | @return EFI_SUCCESS The printing was successful.\r |
883 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
b1f95a06 | 884 | **/\r |
a405b86d | 885 | EFI_STATUS\r |
b1f95a06 | 886 | EFIAPI\r |
887 | ShellPrintEx(\r | |
888 | IN INT32 Col OPTIONAL,\r | |
889 | IN INT32 Row OPTIONAL,\r | |
890 | IN CONST CHAR16 *Format,\r | |
891 | ...\r | |
892 | );\r | |
893 | \r | |
2247dde4 | 894 | /**\r |
895 | Print at a specific location on the screen.\r | |
896 | \r | |
a5bd42b9 | 897 | This function will move the cursor to a given screen location and print the specified string.\r |
1e6e84c7 | 898 | \r |
899 | If -1 is specified for either the Row or Col the current screen location for BOTH\r | |
a5bd42b9 | 900 | will be used.\r |
2247dde4 | 901 | \r |
a5bd42b9 | 902 | If either Row or Col is out of range for the current console, then ASSERT.\r |
903 | If Format is NULL, then ASSERT.\r | |
2247dde4 | 904 | \r |
1e6e84c7 | 905 | In addition to the standard %-based flags as supported by UefiLib Print() this supports\r |
2247dde4 | 906 | the following additional flags:\r |
18cefebe | 907 | %N - Set output attribute to normal.\r |
908 | %H - Set output attribute to highlight.\r | |
909 | %E - Set output attribute to error.\r | |
910 | %B - Set output attribute to blue color.\r | |
911 | %V - Set output attribute to green color.\r | |
2247dde4 | 912 | \r |
913 | Note: The background color is controlled by the shell command cls.\r | |
914 | \r | |
18cefebe | 915 | @param[in] Col The column to print at.\r |
a405b86d | 916 | @param[in] Row The row to print at.\r |
1e6e84c7 | 917 | @param[in] Language The language of the string to retrieve. If this parameter\r |
918 | is NULL, then the current platform language is used.\r | |
18cefebe | 919 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r |
920 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
a405b86d | 921 | @param[in] ... The variable argument list.\r |
2247dde4 | 922 | \r |
a405b86d | 923 | @return EFI_SUCCESS The printing was successful.\r |
924 | @return EFI_DEVICE_ERROR The console device reported an error.\r | |
2247dde4 | 925 | **/\r |
a405b86d | 926 | EFI_STATUS\r |
2247dde4 | 927 | EFIAPI\r |
928 | ShellPrintHiiEx(\r | |
929 | IN INT32 Col OPTIONAL,\r | |
930 | IN INT32 Row OPTIONAL,\r | |
1e6e84c7 | 931 | IN CONST CHAR8 *Language OPTIONAL,\r |
2247dde4 | 932 | IN CONST EFI_STRING_ID HiiFormatStringId,\r |
933 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
934 | ...\r | |
935 | );\r | |
936 | \r | |
937 | /**\r | |
a31bd33c | 938 | Function to determine if a given filename represents a directory.\r |
2247dde4 | 939 | \r |
18cefebe | 940 | If DirName is NULL, then ASSERT.\r |
941 | \r | |
2247dde4 | 942 | @param[in] DirName Path to directory to test.\r |
943 | \r | |
a31bd33c | 944 | @retval EFI_SUCCESS The Path represents a directory.\r |
945 | @retval EFI_NOT_FOUND The Path does not represent a directory.\r | |
946 | @retval other The path failed to open.\r | |
2247dde4 | 947 | **/\r |
948 | EFI_STATUS\r | |
949 | EFIAPI\r | |
950 | ShellIsDirectory(\r | |
951 | IN CONST CHAR16 *DirName\r | |
952 | );\r | |
953 | \r | |
a31bd33c | 954 | /**\r |
955 | Function to determine if a given filename represents a file.\r | |
956 | \r | |
b3011f40 | 957 | This will search the CWD only.\r |
958 | \r | |
18cefebe | 959 | If Name is NULL, then ASSERT.\r |
960 | \r | |
a31bd33c | 961 | @param[in] Name Path to file to test.\r |
962 | \r | |
963 | @retval EFI_SUCCESS The Path represents a file.\r | |
964 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
965 | @retval other The path failed to open.\r | |
966 | **/\r | |
967 | EFI_STATUS\r | |
968 | EFIAPI\r | |
969 | ShellIsFile(\r | |
970 | IN CONST CHAR16 *Name\r | |
971 | );\r | |
972 | \r | |
b3011f40 | 973 | /**\r |
974 | Function to determine if a given filename represents a file.\r | |
975 | \r | |
976 | This will search the CWD and then the Path.\r | |
977 | \r | |
978 | If Name is NULL, then ASSERT.\r | |
979 | \r | |
980 | @param[in] Name Path to file to test.\r | |
981 | \r | |
982 | @retval EFI_SUCCESS The Path represents a file.\r | |
983 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
984 | @retval other The path failed to open.\r | |
985 | **/\r | |
986 | EFI_STATUS\r | |
987 | EFIAPI\r | |
988 | ShellIsFileInPath(\r | |
989 | IN CONST CHAR16 *Name\r | |
990 | );\r | |
991 | \r | |
125c2cf4 | 992 | /**\r |
1e6e84c7 | 993 | Function to determine whether a string is decimal or hex representation of a number\r |
125c2cf4 | 994 | and return the number converted from the string.\r |
995 | \r | |
b0934ac4 | 996 | Note: this function cannot be used when (UINTN)(-1), (0xFFFFFFFF) may be a valid\r |
4bbdc0e1 | 997 | result. Use ShellConvertStringToUint64 instead.\r |
998 | \r | |
999 | @param[in] String String representation of a number.\r | |
125c2cf4 | 1000 | \r |
a31bd33c | 1001 | @return The unsigned integer result of the conversion.\r |
4bbdc0e1 | 1002 | @retval (UINTN)(-1) An error occured.\r |
125c2cf4 | 1003 | **/\r |
1004 | UINTN\r | |
1005 | EFIAPI\r | |
1006 | ShellStrToUintn(\r | |
1007 | IN CONST CHAR16 *String\r | |
1008 | );\r | |
1009 | \r | |
1010 | /**\r | |
1e6e84c7 | 1011 | Safely append with automatic string resizing given length of Destination and\r |
125c2cf4 | 1012 | desired length of copy from Source.\r |
1013 | \r | |
1e6e84c7 | 1014 | Append the first D characters of Source to the end of Destination, where D is\r |
1015 | the lesser of Count and the StrLen() of Source. If appending those D characters\r | |
1016 | will fit within Destination (whose Size is given as CurrentSize) and\r | |
1017 | still leave room for a NULL terminator, then those characters are appended,\r | |
1018 | starting at the original terminating NULL of Destination, and a new terminating\r | |
1019 | NULL is appended.\r | |
125c2cf4 | 1020 | \r |
1021 | If appending D characters onto Destination will result in a overflow of the size\r | |
1022 | given in CurrentSize the string will be grown such that the copy can be performed\r | |
1023 | and CurrentSize will be updated to the new size.\r | |
1024 | \r | |
a405b86d | 1025 | If Source is NULL, there is nothing to append, so return the current buffer in\r |
125c2cf4 | 1026 | Destination.\r |
1027 | \r | |
18cefebe | 1028 | If Destination is NULL, then ASSERT().\r |
1e6e84c7 | 1029 | If Destination's current length (including NULL terminator) is already more than\r |
a31bd33c | 1030 | CurrentSize, then ASSERT().\r |
125c2cf4 | 1031 | \r |
4ff7e37b ED |
1032 | @param[in, out] Destination The String to append onto.\r |
1033 | @param[in, out] CurrentSize On call, the number of bytes in Destination. On\r | |
1034 | return, possibly the new size (still in bytes). If NULL,\r | |
1035 | then allocate whatever is needed.\r | |
1036 | @param[in] Source The String to append from.\r | |
1037 | @param[in] Count The maximum number of characters to append. If 0, then\r | |
1038 | all are appended.\r | |
125c2cf4 | 1039 | \r |
a405b86d | 1040 | @return The Destination after appending the Source.\r |
125c2cf4 | 1041 | **/\r |
1e6e84c7 | 1042 | CHAR16*\r |
125c2cf4 | 1043 | EFIAPI\r |
1044 | StrnCatGrow (\r | |
1045 | IN OUT CHAR16 **Destination,\r | |
1046 | IN OUT UINTN *CurrentSize,\r | |
1047 | IN CONST CHAR16 *Source,\r | |
1048 | IN UINTN Count\r | |
1049 | );\r | |
2247dde4 | 1050 | \r |
b3011f40 | 1051 | /**\r |
1e6e84c7 | 1052 | This is a find and replace function. Upon successful return the NewString is a copy of\r |
b3011f40 | 1053 | SourceString with each instance of FindTarget replaced with ReplaceWith.\r |
1054 | \r | |
1055 | If SourceString and NewString overlap the behavior is undefined.\r | |
1056 | \r | |
1057 | If the string would grow bigger than NewSize it will halt and return error.\r | |
1058 | \r | |
4ff7e37b ED |
1059 | @param[in] SourceString The string with source buffer.\r |
1060 | @param[in, out] NewString The string with resultant buffer.\r | |
1061 | @param[in] NewSize The size in bytes of NewString.\r | |
1062 | @param[in] FindTarget The string to look for.\r | |
1063 | @param[in] ReplaceWith The string to replace FindTarget with.\r | |
1064 | @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r | |
1065 | immediately before it.\r | |
1066 | @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r | |
b3011f40 | 1067 | \r |
1068 | @retval EFI_INVALID_PARAMETER SourceString was NULL.\r | |
1069 | @retval EFI_INVALID_PARAMETER NewString was NULL.\r | |
1070 | @retval EFI_INVALID_PARAMETER FindTarget was NULL.\r | |
1071 | @retval EFI_INVALID_PARAMETER ReplaceWith was NULL.\r | |
1072 | @retval EFI_INVALID_PARAMETER FindTarget had length < 1.\r | |
1073 | @retval EFI_INVALID_PARAMETER SourceString had length < 1.\r | |
1e6e84c7 | 1074 | @retval EFI_BUFFER_TOO_SMALL NewSize was less than the minimum size to hold\r |
b3011f40 | 1075 | the new string (truncation occurred).\r |
a405b86d | 1076 | @retval EFI_SUCCESS The string was successfully copied with replacement.\r |
b3011f40 | 1077 | **/\r |
b3011f40 | 1078 | EFI_STATUS\r |
1079 | EFIAPI\r | |
a405b86d | 1080 | ShellCopySearchAndReplace(\r |
b3011f40 | 1081 | IN CHAR16 CONST *SourceString,\r |
a405b86d | 1082 | IN OUT CHAR16 *NewString,\r |
b3011f40 | 1083 | IN UINTN NewSize,\r |
1084 | IN CONST CHAR16 *FindTarget,\r | |
969c783b | 1085 | IN CONST CHAR16 *ReplaceWith,\r |
a405b86d | 1086 | IN CONST BOOLEAN SkipPreCarrot,\r |
1087 | IN CONST BOOLEAN ParameterReplacing\r | |
b3011f40 | 1088 | );\r |
1089 | \r | |
1090 | /**\r | |
1091 | Check if a Unicode character is a hexadecimal character.\r | |
1092 | \r | |
1e6e84c7 | 1093 | This internal function checks if a Unicode character is a\r |
a405b86d | 1094 | numeric character. The valid hexadecimal characters are\r |
b3011f40 | 1095 | L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r |
1096 | \r | |
b3011f40 | 1097 | \r |
a405b86d | 1098 | @param Char The character to check against.\r |
1099 | \r | |
1100 | @retval TRUE The Char is a hexadecmial character.\r | |
1101 | @retval FALSE The Char is not a hexadecmial character.\r | |
b3011f40 | 1102 | \r |
1103 | **/\r | |
1104 | BOOLEAN\r | |
1105 | EFIAPI\r | |
969c783b | 1106 | ShellIsHexaDecimalDigitCharacter (\r |
b3011f40 | 1107 | IN CHAR16 Char\r |
1108 | );\r | |
1109 | \r | |
a405b86d | 1110 | /**\r |
1111 | Check if a Unicode character is a decimal character.\r | |
1112 | \r | |
1113 | This internal function checks if a Unicode character is a\r | |
1114 | decimal character. The valid characters are\r | |
1115 | L'0' to L'9'.\r | |
1116 | \r | |
1117 | \r | |
1118 | @param Char The character to check against.\r | |
1119 | \r | |
1120 | @retval TRUE The Char is a hexadecmial character.\r | |
1121 | @retval FALSE The Char is not a hexadecmial character.\r | |
1122 | \r | |
1123 | **/\r | |
1124 | BOOLEAN\r | |
1125 | EFIAPI\r | |
1126 | ShellIsDecimalDigitCharacter (\r | |
1127 | IN CHAR16 Char\r | |
1128 | );\r | |
1129 | \r | |
334f978e | 1130 | ///\r |
a405b86d | 1131 | /// What type of answer is requested.\r |
334f978e | 1132 | ///\r |
1133 | typedef enum {\r | |
a405b86d | 1134 | ShellPromptResponseTypeYesNo,\r |
1135 | ShellPromptResponseTypeYesNoCancel,\r | |
1136 | ShellPromptResponseTypeFreeform,\r | |
1137 | ShellPromptResponseTypeQuitContinue,\r | |
1138 | ShellPromptResponseTypeYesNoAllCancel,\r | |
1139 | ShellPromptResponseTypeEnterContinue,\r | |
1140 | ShellPromptResponseTypeAnyKeyContinue,\r | |
1141 | ShellPromptResponseTypeMax\r | |
334f978e | 1142 | } SHELL_PROMPT_REQUEST_TYPE;\r |
1143 | \r | |
1144 | ///\r | |
a405b86d | 1145 | /// What answer was given.\r |
334f978e | 1146 | ///\r |
1147 | typedef enum {\r | |
a405b86d | 1148 | ShellPromptResponseYes,\r |
1149 | ShellPromptResponseNo,\r | |
1150 | ShellPromptResponseCancel,\r | |
1151 | ShellPromptResponseQuit,\r | |
1152 | ShellPromptResponseContinue,\r | |
1153 | ShellPromptResponseAll,\r | |
1154 | ShellPromptResponseMax\r | |
334f978e | 1155 | } SHELL_PROMPT_RESPONSE;\r |
1156 | \r | |
1157 | /**\r | |
1158 | Prompt the user and return the resultant answer to the requestor.\r | |
1159 | \r | |
1160 | This function will display the requested question on the shell prompt and then\r | |
1161 | wait for an apropriate answer to be input from the console.\r | |
1162 | \r | |
a405b86d | 1163 | If the SHELL_PROMPT_REQUEST_TYPE is SHELL_PROMPT_REQUEST_TYPE_YESNO, ShellPromptResponseTypeQuitContinue\r |
334f978e | 1164 | or SHELL_PROMPT_REQUEST_TYPE_YESNOCANCEL then *Response is of type SHELL_PROMPT_RESPONSE.\r |
1165 | \r | |
a405b86d | 1166 | If the SHELL_PROMPT_REQUEST_TYPE is ShellPromptResponseTypeFreeform then *Response is of type\r |
334f978e | 1167 | CHAR16*.\r |
1168 | \r | |
1169 | In either case *Response must be callee freed if Response was not NULL;\r | |
1170 | \r | |
1171 | @param Type What type of question is asked. This is used to filter the input\r | |
1172 | to prevent invalid answers to question.\r | |
a405b86d | 1173 | @param Prompt The pointer to a string prompt used to request input.\r |
1174 | @param Response The pointer to Response, which will be populated upon return.\r | |
334f978e | 1175 | \r |
a405b86d | 1176 | @retval EFI_SUCCESS The operation was successful.\r |
334f978e | 1177 | @retval EFI_UNSUPPORTED The operation is not supported as requested.\r |
1178 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r | |
1179 | @return other The operation failed.\r | |
1180 | **/\r | |
1181 | EFI_STATUS\r | |
1182 | EFIAPI\r | |
1183 | ShellPromptForResponse (\r | |
1184 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
1185 | IN CHAR16 *Prompt OPTIONAL,\r | |
1186 | IN OUT VOID **Response OPTIONAL\r | |
1187 | );\r | |
1188 | \r | |
1189 | /**\r | |
1190 | Prompt the user and return the resultant answer to the requestor.\r | |
1191 | \r | |
1192 | This function is the same as ShellPromptForResponse, except that the prompt is\r | |
1193 | automatically pulled from HII.\r | |
1194 | \r | |
4bbdc0e1 | 1195 | @param[in] Type What type of question is asked. This is used to filter the input\r |
334f978e | 1196 | to prevent invalid answers to question.\r |
4ff7e37b ED |
1197 | @param[in] HiiFormatStringId The format string Id for getting from Hii.\r |
1198 | @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r | |
1199 | @param[in, out] Response The pointer to Response, which will be populated upon return.\r | |
334f978e | 1200 | \r |
a405b86d | 1201 | @retval EFI_SUCCESS The operation was sucessful.\r |
1202 | @return other The operation failed.\r | |
334f978e | 1203 | \r |
1204 | @sa ShellPromptForResponse\r | |
1205 | **/\r | |
1206 | EFI_STATUS\r | |
1207 | EFIAPI\r | |
1208 | ShellPromptForResponseHii (\r | |
1209 | IN SHELL_PROMPT_REQUEST_TYPE Type,\r | |
1210 | IN CONST EFI_STRING_ID HiiFormatStringId,\r | |
1211 | IN CONST EFI_HANDLE HiiFormatHandle,\r | |
1212 | IN OUT VOID **Response\r | |
1213 | );\r | |
1214 | \r | |
a405b86d | 1215 | /**\r |
1216 | Function to determin if an entire string is a valid number.\r | |
1217 | \r | |
4bbdc0e1 | 1218 | If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r |
a405b86d | 1219 | \r |
1220 | @param[in] String The string to evaluate.\r | |
1221 | @param[in] ForceHex TRUE - always assume hex.\r | |
1222 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to keep going.\r | |
1223 | \r | |
1224 | @retval TRUE It is all numeric (dec/hex) characters.\r | |
1225 | @retval FALSE There is a non-numeric character.\r | |
1226 | **/\r | |
1227 | BOOLEAN\r | |
1228 | EFIAPI\r | |
1229 | ShellIsHexOrDecimalNumber (\r | |
1230 | IN CONST CHAR16 *String,\r | |
1231 | IN CONST BOOLEAN ForceHex,\r | |
1232 | IN CONST BOOLEAN StopAtSpace\r | |
1233 | );\r | |
1234 | \r | |
4bbdc0e1 | 1235 | /**\r |
1236 | Function to verify and convert a string to its numerical 64 bit representation.\r | |
1237 | \r | |
1238 | If Hex it must be preceeded with a 0x, 0X, or has ForceHex set TRUE.\r | |
1239 | \r | |
1240 | @param[in] String The string to evaluate.\r | |
1241 | @param[out] Value Upon a successful return the value of the conversion.\r | |
1242 | @param[in] ForceHex TRUE - always assume hex.\r | |
b0934ac4 | 1243 | @param[in] StopAtSpace TRUE to halt upon finding a space, FALSE to\r |
4bbdc0e1 | 1244 | process the entire String.\r |
b0934ac4 | 1245 | \r |
4bbdc0e1 | 1246 | @retval EFI_SUCCESS The conversion was successful.\r |
1247 | @retval EFI_INVALID_PARAMETER String contained an invalid character.\r | |
1248 | @retval EFI_NOT_FOUND String was a number, but Value was NULL.\r | |
1249 | **/\r | |
1250 | EFI_STATUS\r | |
1251 | EFIAPI\r | |
1252 | ShellConvertStringToUint64(\r | |
1253 | IN CONST CHAR16 *String,\r | |
1254 | OUT UINT64 *Value,\r | |
1255 | IN CONST BOOLEAN ForceHex,\r | |
1256 | IN CONST BOOLEAN StopAtSpace\r | |
1257 | );\r | |
1258 | \r | |
a405b86d | 1259 | /**\r |
1260 | Function to determine if a given filename exists.\r | |
1261 | \r | |
1262 | @param[in] Name Path to test.\r | |
1263 | \r | |
1264 | @retval EFI_SUCCESS The Path represents a file.\r | |
1265 | @retval EFI_NOT_FOUND The Path does not represent a file.\r | |
1266 | @retval other The path failed to open.\r | |
1267 | **/\r | |
1268 | EFI_STATUS\r | |
1269 | EFIAPI\r | |
1270 | ShellFileExists(\r | |
1271 | IN CONST CHAR16 *Name\r | |
1272 | );\r | |
334f978e | 1273 | \r |
4d0a4fce | 1274 | /**\r |
1275 | Function to read a single line from a SHELL_FILE_HANDLE. The \n is not included in the returned\r | |
1276 | buffer. The returned buffer must be callee freed.\r | |
1277 | \r | |
1278 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
1279 | maintained and not changed for all operations with the same file.\r | |
1280 | \r | |
4ff7e37b ED |
1281 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
1282 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
1283 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 1284 | \r |
4ff7e37b | 1285 | @return The line of text from the file.\r |
4d0a4fce | 1286 | \r |
1287 | @sa ShellFileHandleReadLine\r | |
1288 | **/\r | |
1289 | CHAR16*\r | |
1290 | EFIAPI\r | |
1291 | ShellFileHandleReturnLine(\r | |
1292 | IN SHELL_FILE_HANDLE Handle,\r | |
1293 | IN OUT BOOLEAN *Ascii\r | |
1294 | );\r | |
1295 | \r | |
1296 | /**\r | |
1297 | Function to read a single line (up to but not including the \n) from a SHELL_FILE_HANDLE.\r | |
1298 | \r | |
1299 | If the position upon start is 0, then the Ascii Boolean will be set. This should be\r | |
1300 | maintained and not changed for all operations with the same file.\r | |
1301 | \r | |
4ff7e37b ED |
1302 | @param[in] Handle SHELL_FILE_HANDLE to read from.\r |
1303 | @param[in, out] Buffer The pointer to buffer to read into.\r | |
1304 | @param[in, out] Size The pointer to number of bytes in Buffer.\r | |
1305 | @param[in] Truncate If the buffer is large enough, this has no effect.\r | |
1306 | If the buffer is is too small and Truncate is TRUE,\r | |
1307 | the line will be truncated.\r | |
1308 | If the buffer is is too small and Truncate is FALSE,\r | |
1309 | then no read will occur.\r | |
1310 | \r | |
1311 | @param[in, out] Ascii Boolean value for indicating whether the file is\r | |
1312 | Ascii (TRUE) or UCS2 (FALSE).\r | |
4d0a4fce | 1313 | \r |
1314 | @retval EFI_SUCCESS The operation was successful. The line is stored in\r | |
1315 | Buffer.\r | |
1316 | @retval EFI_INVALID_PARAMETER Handle was NULL.\r | |
1317 | @retval EFI_INVALID_PARAMETER Size was NULL.\r | |
1318 | @retval EFI_BUFFER_TOO_SMALL Size was not large enough to store the line.\r | |
1319 | Size was updated to the minimum space required.\r | |
1320 | **/\r | |
1321 | EFI_STATUS\r | |
1322 | EFIAPI\r | |
1323 | ShellFileHandleReadLine(\r | |
1324 | IN SHELL_FILE_HANDLE Handle,\r | |
1325 | IN OUT CHAR16 *Buffer,\r | |
1326 | IN OUT UINTN *Size,\r | |
1327 | IN BOOLEAN Truncate,\r | |
1328 | IN OUT BOOLEAN *Ascii\r | |
1329 | );\r | |
1330 | \r | |
e9880e25 | 1331 | #endif // __SHELL_LIB__\r |