X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=ShellPkg%2FInclude%2FLibrary%2FShellLib.h;h=ad3cc01f424d789d335e1272496f6725c75e79f1;hp=5614d7174f59063620b081aad3bbe57cc7d9a3ef;hb=630b41877e9a1afe59d4f8a1c22bc691fe933ff8;hpb=d2b4564ba50b095d5a5e00b9c7bebef004967d5e diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h index 5614d7174f..ad3cc01f42 100644 --- a/ShellPkg/Include/Library/ShellLib.h +++ b/ShellPkg/Include/Library/ShellLib.h @@ -22,8 +22,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. This function will retrieve the information about the file for the handle specified and store it in allocated pool memory. - This function allocates a buffer to store the file’s information. It is the - caller’s responsibility to free the buffer + This function allocates a buffer to store the file's information. It is the + caller's responsibility to free the buffer @param FileHandle The file handle of the file for which information is being requested. @@ -106,7 +106,7 @@ ShellOpenFileByDevicePath( /** This function will open a file or directory referenced by filename. - If return is EFI_SUCCESS, the Filehandle is the opened file’s handle; + If return is EFI_SUCCESS, the Filehandle is the opened file's handle; otherwise, the Filehandle is NULL. The Attributes is valid only for EFI_FILE_MODE_CREATE. @@ -179,11 +179,11 @@ ShellCreateDirectory( This function reads information from an opened file. If FileHandle is not a directory, the function reads the requested number of - bytes from the file at the file’s current position and returns them in Buffer. + bytes from the file at the file's current position and returns them in Buffer. If the read goes beyond the end of the file, the read length is truncated to the - end of the file. The file’s current position is increased by the number of bytes + end of the file. The file's current position is increased by the number of bytes returned. If FileHandle is a directory, the function reads the directory entry - at the file’s current position and returns the entry in Buffer. If the Buffer + at the file's current position and returns the entry in Buffer. If the Buffer is not large enough to hold the current directory entry, then EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. BufferSize is set to be the size of the buffer needed to read the entry. On @@ -220,7 +220,7 @@ ShellReadFile( This function writes the specified number of bytes to the file at the current file position. The current file position is advanced the actual number of bytes written, which is returned in BufferSize. Partial writes only occur when there - has been a data error during the write attempt (such as “volume space full”). + has been a data error during the write attempt (such as "volume space full"). The file is automatically grown to hold the data if required. Direct writes to opened directories are not supported. @@ -251,7 +251,7 @@ ShellWriteFile( /** Close an open file handle. - This function closes a specified file handle. All “dirty” cached file data is + This function closes a specified file handle. All "dirty" cached file data is flushed to the device, and the file is closed. In all cases the handle is closed. @@ -411,7 +411,7 @@ ShellFindNextFile( /** Retrieve the size of a file. - This function extracts the file size info from the FileHandle’s EFI_FILE_INFO + This function extracts the file size info from the FileHandle's EFI_FILE_INFO data. @param FileHandle file handle from which size is retrieved @@ -527,7 +527,7 @@ ShellExecute ( /** Retreives the current directory path - If the DeviceName is NULL, it returns the current device’s current directory + If the DeviceName is NULL, it returns the current device's current directory name. If the DeviceName is not NULL, it returns the current directory name on specified drive.