This function opens a file with the open mode according to the file path. The\r
Attributes is valid only for EFI_FILE_MODE_CREATE.\r
\r
- @param[in,out] FilePath On input, the device path to the file. On output,\r
- the remaining device path.\r
- @param[out] DeviceHandle Pointer to the system device handle.\r
- @param[out] FileHandle Pointer to the file handle.\r
- @param[in] OpenMode The mode to open the file with.\r
- @param[in] Attributes The file's file attributes.\r
+ @param[in, out] FilePath On input, the device path to the file. On output,\r
+ the remaining device path.\r
+ @param[out] DeviceHandle Pointer to the system device handle.\r
+ @param[out] FileHandle Pointer to the file handle.\r
+ @param[in] OpenMode The mode to open the file with.\r
+ @param[in] Attributes The file's file attributes.\r
\r
@retval EFI_SUCCESS The information was set.\r
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
are no more directory entries, the read returns a zero-length buffer.\r
EFI_FILE_INFO is the structure returned as the directory entry.\r
\r
- @param[in] FileHandle The opened file handle.\r
- @param[in,out] ReadSize On input the size of buffer in bytes. On return\r
- the number of bytes written.\r
- @param[out] Buffer The buffer to put read data into.\r
+ @param[in] FileHandle The opened file handle.\r
+ @param[in, out] ReadSize On input the size of buffer in bytes. On return\r
+ the number of bytes written.\r
+ @param[out] Buffer The buffer to put read data into.\r
\r
@retval EFI_SUCCESS Data was read.\r
@retval EFI_NO_MEDIA The device has no media.\r
The file is automatically grown to hold the data if required. Direct writes to\r
opened directories are not supported.\r
\r
- @param[in] FileHandle The opened file for writing.\r
+ @param[in] FileHandle The opened file for writing.\r
\r
- @param[in,out] BufferSize On input the number of bytes in Buffer. On output\r
- the number of bytes written.\r
+ @param[in, out] BufferSize On input the number of bytes in Buffer. On output\r
+ the number of bytes written.\r
\r
- @param[in] Buffer The buffer containing data to write is stored.\r
+ @param[in] Buffer The buffer containing data to write is stored.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.\r
call of this function has no file to get. *NoFile will be set to TRUE, and the\r
data in Buffer is meaningless.\r
\r
- @param[in] DirHandle The file handle of the directory.\r
- @param[in,out] Buffer The pointer to buffer for file's information.\r
- @param[in,out] NoFile The pointer to boolean when last file is found.\r
+ @param[in] DirHandle The file handle of the directory.\r
+ @param[in, out] Buffer The pointer to buffer for file's information.\r
+ @param[in, out] NoFile The pointer to boolean when last file is found.\r
\r
@retval EFI_SUCCESS Found the next file.\r
@retval EFI_NO_MEDIA The device has no media.\r
If you are NOT appending to an existing list *ListHead must be NULL. If\r
*ListHead is NULL then it must be callee freed.\r
\r
- @param[in] Arg The pointer to path string.\r
- @param[in] OpenMode Mode to open files with.\r
- @param[in,out] ListHead Head of linked list of results.\r
+ @param[in] Arg The pointer to path string.\r
+ @param[in] OpenMode Mode to open files with.\r
+ @param[in, out] ListHead Head of linked list of results.\r
\r
@retval EFI_SUCCESS The operation was sucessful and the list head\r
contains the list of opened files.\r
/**\r
Free the linked list returned from ShellOpenFileMetaArg.\r
\r
- @param[in,out] ListHead The pointer to free.\r
+ @param[in, out] ListHead The pointer to free.\r
\r
@retval EFI_SUCCESS The operation was sucessful.\r
@retval EFI_INVALID_PARAMETER A parameter was invalid.\r
If Destination's current length (including NULL terminator) is already more than\r
CurrentSize, then ASSERT().\r
\r
- @param[in,out] Destination The String to append onto.\r
- @param[in,out] CurrentSize On call, the number of bytes in Destination. On\r
- return, possibly the new size (still in bytes). If NULL,\r
- then allocate whatever is needed.\r
- @param[in] Source The String to append from.\r
- @param[in] Count The maximum number of characters to append. If 0, then\r
- all are appended.\r
+ @param[in, out] Destination The String to append onto.\r
+ @param[in, out] CurrentSize On call, the number of bytes in Destination. On\r
+ return, possibly the new size (still in bytes). If NULL,\r
+ then allocate whatever is needed.\r
+ @param[in] Source The String to append from.\r
+ @param[in] Count The maximum number of characters to append. If 0, then\r
+ all are appended.\r
\r
@return The Destination after appending the Source.\r
**/\r
\r
If the string would grow bigger than NewSize it will halt and return error.\r
\r
- @param[in] SourceString The string with source buffer.\r
- @param[in,out] NewString The string with resultant buffer.\r
- @param[in] NewSize The size in bytes of NewString.\r
- @param[in] FindTarget The string to look for.\r
- @param[in] ReplaceWith The string to replace FindTarget with.\r
- @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
- immediately before it.\r
- @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
+ @param[in] SourceString The string with source buffer.\r
+ @param[in, out] NewString The string with resultant buffer.\r
+ @param[in] NewSize The size in bytes of NewString.\r
+ @param[in] FindTarget The string to look for.\r
+ @param[in] ReplaceWith The string to replace FindTarget with.\r
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'\r
+ immediately before it.\r
+ @param[in] ParameterReplacing If TRUE will add "" around items with spaces.\r
\r
@retval EFI_INVALID_PARAMETER SourceString was NULL.\r
@retval EFI_INVALID_PARAMETER NewString was NULL.\r
\r
@param[in] Type What type of question is asked. This is used to filter the input\r
to prevent invalid answers to question.\r
- @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
- @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
- @param[in,out] Response The pointer to Response, which will be populated upon return.\r
+ @param[in] HiiFormatStringId The format string Id for getting from Hii.\r
+ @param[in] HiiFormatHandle The format string Handle for getting from Hii.\r
+ @param[in, out] Response The pointer to Response, which will be populated upon return.\r
\r
@retval EFI_SUCCESS The operation was sucessful.\r
@return other The operation failed.\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
- @return The line of text from the file.\r
+ @return The line of text from the file.\r
\r
@sa ShellFileHandleReadLine\r
**/\r
If the position upon start is 0, then the Ascii Boolean will be set. This should be\r
maintained and not changed for all operations with the same file.\r
\r
- @param[in] Handle SHELL_FILE_HANDLE to read from.\r
- @param[in,out] Buffer The pointer to buffer to read into.\r
- @param[in,out] Size The pointer to number of bytes in Buffer.\r
- @param[in] Truncate If the buffer is large enough, this has no effect.\r
- If the buffer is is too small and Truncate is TRUE,\r
- the line will be truncated.\r
- If the buffer is is too small and Truncate is FALSE,\r
- then no read will occur.\r
-\r
- @param[in,out] Ascii Boolean value for indicating whether the file is\r
- Ascii (TRUE) or UCS2 (FALSE).\r
+ @param[in] Handle SHELL_FILE_HANDLE to read from.\r
+ @param[in, out] Buffer The pointer to buffer to read into.\r
+ @param[in, out] Size The pointer to number of bytes in Buffer.\r
+ @param[in] Truncate If the buffer is large enough, this has no effect.\r
+ If the buffer is is too small and Truncate is TRUE,\r
+ the line will be truncated.\r
+ If the buffer is is too small and Truncate is FALSE,\r
+ then no read will occur.\r
+\r
+ @param[in, out] Ascii Boolean value for indicating whether the file is\r
+ Ascii (TRUE) or UCS2 (FALSE).\r
\r
@retval EFI_SUCCESS The operation was successful. The line is stored in\r
Buffer.\r
projects / mirror_edk2.git / blobdiff