git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8350
6f19259b-4bc3-4df7-8a09-
765794883524
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
- This function allocates a buffer to store the file\92s information. It is the \r
- caller\92s responsibility to free the buffer\r
+ This function allocates a buffer to store the file's information. It is the \r
+ caller's responsibility to free the buffer\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
- bytes from the file at the file\92s current position and returns them in Buffer. \r
+ bytes from the file at the file's current position and returns them in Buffer. \r
If the read goes beyond the end of the file, the read length is truncated to the\r
If the read goes beyond the end of the file, the read length is truncated to the\r
- end of the file. The file\92s current position is increased by the number of bytes \r
+ end of the file. The file's current position is increased by the number of bytes \r
returned. If FileHandle is a directory, the function reads the directory entry \r
returned. If FileHandle is a directory, the function reads the directory entry \r
- at the file\92s current position and returns the entry in Buffer. If the Buffer \r
+ at the file's current position and returns the entry in Buffer. If the Buffer \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
- has been a data error during the write attempt (such as \93volume space full\94). \r
+ has been a data error during the write attempt (such as "volume space full"). \r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
/** \r
Close an open file handle.\r
\r
/** \r
Close an open file handle.\r
\r
- This function closes a specified file handle. All \93dirty\94 cached file data is \r
+ This function closes a specified file handle. All "dirty" cached file data is \r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
/**\r
Retrieves the first file from a directory\r
\r
/**\r
Retrieves the first file from a directory\r
\r
- This function opens a directory and gets the first file\92s info in the \r
+ This function opens a directory and gets the first file's info in the \r
directory. Caller can use FileHandleFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on *Buffer.\r
\r
directory. Caller can use FileHandleFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on *Buffer.\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
- This function extracts the file size info from the FileHandle\92s EFI_FILE_INFO \r
+ This function extracts the file size info from the FileHandle's EFI_FILE_INFO \r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
- This function allocates a buffer to store the file\92s information. It is the \r
- caller\92s responsibility to free the buffer\r
+ This function allocates a buffer to store the file's information. It is the \r
+ caller's responsibility to free the buffer\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
/**\r
This function will open a file or directory referenced by filename.\r
\r
/**\r
This function will open a file or directory referenced by filename.\r
\r
- If return is EFI_SUCCESS, the Filehandle is the opened file\92s handle; \r
+ If return is EFI_SUCCESS, the Filehandle is the opened file's handle; \r
otherwise, the Filehandle is NULL. The Attributes is valid only for \r
EFI_FILE_MODE_CREATE.\r
\r
otherwise, the Filehandle is NULL. The Attributes is valid only for \r
EFI_FILE_MODE_CREATE.\r
\r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
- bytes from the file at the file\92s current position and returns them in Buffer. \r
+ bytes from the file at the file's current position and returns them in Buffer. \r
If the read goes beyond the end of the file, the read length is truncated to the\r
If the read goes beyond the end of the file, the read length is truncated to the\r
- end of the file. The file\92s current position is increased by the number of bytes \r
+ end of the file. The file's current position is increased by the number of bytes \r
returned. If FileHandle is a directory, the function reads the directory entry \r
returned. If FileHandle is a directory, the function reads the directory entry \r
- at the file\92s current position and returns the entry in Buffer. If the Buffer \r
+ at the file's current position and returns the entry in Buffer. If the Buffer \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
- has been a data error during the write attempt (such as \93volume space full\94). \r
+ has been a data error during the write attempt (such as "volume space full"). \r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
/** \r
Close an open file handle.\r
\r
/** \r
Close an open file handle.\r
\r
- This function closes a specified file handle. All \93dirty\94 cached file data is \r
+ This function closes a specified file handle. All "dirty" cached file data is \r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
/**\r
Retrieve the size of a file.\r
\r
/**\r
Retrieve the size of a file.\r
\r
- This function extracts the file size info from the FileHandle\92s EFI_FILE_INFO \r
+ This function extracts the file size info from the FileHandle's EFI_FILE_INFO \r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
/**\r
Retreives the current directory path\r
\r
/**\r
Retreives the current directory path\r
\r
- If the DeviceName is NULL, it returns the current device\92s current directory \r
+ If the DeviceName is NULL, it returns the current device's current directory \r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r
NULL and EFI_NOT_FOUND will be returned.\r
\r
If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the\r
NULL and EFI_NOT_FOUND will be returned.\r
\r
If EFI_DEVICE_NAME_USE_COMPONENT_NAME is set, then the function will return the\r
- device\92s name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on\r
+ device's name using the EFI_COMPONENT_NAME2_PROTOCOL, if present on\r
DeviceHandle.\r
\r
If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the\r
DeviceHandle.\r
\r
If EFI_DEVICE_NAME_USE_DEVICE_PATH is set, then the function will return the\r
- device\92s name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.\r
+ device's name using the EFI_DEVICE_PATH_PROTOCOL, if present on DeviceHandle.\r
If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and\r
EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then\r
EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.\r
If both EFI_DEVICE_NAME_USE_COMPONENT_NAME and\r
EFI_DEVICE_NAME_USE_DEVICE_PATH are set, then\r
EFI_DEVICE_NAME_USE_COMPONENT_NAME will have higher priority.\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
- This function allocates a buffer to store the file\92s information. It is the \r
- caller\92s responsibility to free the buffer\r
+ This function allocates a buffer to store the file's information. It is the \r
+ caller's responsibility to free the buffer\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
- bytes from the file at the file\92s current position and returns them in Buffer. \r
+ bytes from the file at the file's current position and returns them in Buffer. \r
If the read goes beyond the end of the file, the read length is truncated to the\r
If the read goes beyond the end of the file, the read length is truncated to the\r
- end of the file. The file\92s current position is increased by the number of bytes \r
+ end of the file. The file's current position is increased by the number of bytes \r
returned. If FileHandle is a directory, the function reads the directory entry \r
returned. If FileHandle is a directory, the function reads the directory entry \r
- at the file\92s current position and returns the entry in Buffer. If the Buffer \r
+ at the file's current position and returns the entry in Buffer. If the Buffer \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
- has been a data error during the write attempt (such as \93volume space full\94). \r
+ has been a data error during the write attempt (such as "volume space full"). \r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
/** \r
Close an open file handle.\r
\r
/** \r
Close an open file handle.\r
\r
- This function closes a specified file handle. All \93dirty\94 cached file data is \r
+ This function closes a specified file handle. All "dirty" cached file data is \r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
/**\r
Retrieves the first file from a directory\r
\r
/**\r
Retrieves the first file from a directory\r
\r
- This function opens a directory and gets the first file\92s info in the \r
+ This function opens a directory and gets the first file's info in the \r
directory. Caller can use FileHandleFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on Buffer.\r
\r
directory. Caller can use FileHandleFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on Buffer.\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
- This function extracts the file size info from the FileHandle\92s EFI_FILE_INFO \r
+ This function extracts the file size info from the FileHandle's EFI_FILE_INFO \r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
This function will retrieve the information about the file for the handle \r
specified and store it in allocated pool memory.\r
\r
- This function allocates a buffer to store the file\92s information. It is the \r
- caller\92s responsibility to free the buffer\r
+ This function allocates a buffer to store the file's information. It is the \r
+ caller's responsibility to free the buffer\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
\r
@param FileHandle The file handle of the file for which information is \r
being requested.\r
/**\r
This function will open a file or directory referenced by filename.\r
\r
/**\r
This function will open a file or directory referenced by filename.\r
\r
- If return is EFI_SUCCESS, the Filehandle is the opened file\92s handle; \r
+ If return is EFI_SUCCESS, the Filehandle is the opened file's handle; \r
otherwise, the Filehandle is NULL. The Attributes is valid only for \r
EFI_FILE_MODE_CREATE.\r
\r
otherwise, the Filehandle is NULL. The Attributes is valid only for \r
EFI_FILE_MODE_CREATE.\r
\r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
This function reads information from an opened file.\r
\r
If FileHandle is not a directory, the function reads the requested number of \r
- bytes from the file at the file\92s current position and returns them in Buffer. \r
+ bytes from the file at the file's current position and returns them in Buffer. \r
If the read goes beyond the end of the file, the read length is truncated to the\r
If the read goes beyond the end of the file, the read length is truncated to the\r
- end of the file. The file\92s current position is increased by the number of bytes \r
+ end of the file. The file's current position is increased by the number of bytes \r
returned. If FileHandle is a directory, the function reads the directory entry \r
returned. If FileHandle is a directory, the function reads the directory entry \r
- at the file\92s current position and returns the entry in Buffer. If the Buffer \r
+ at the file's current position and returns the entry in Buffer. If the Buffer \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
is not large enough to hold the current directory entry, then \r
EFI_BUFFER_TOO_SMALL is returned and the current file position is not updated. \r
BufferSize is set to be the size of the buffer needed to read the entry. On \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
This function writes the specified number of bytes to the file at the current \r
file position. The current file position is advanced the actual number of bytes \r
written, which is returned in BufferSize. Partial writes only occur when there \r
- has been a data error during the write attempt (such as \93volume space full\94). \r
+ has been a data error during the write attempt (such as "volume space full"). \r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
The file is automatically grown to hold the data if required. Direct writes to \r
opened directories are not supported.\r
\r
/** \r
Close an open file handle.\r
\r
/** \r
Close an open file handle.\r
\r
- This function closes a specified file handle. All \93dirty\94 cached file data is \r
+ This function closes a specified file handle. All "dirty" cached file data is \r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
flushed to the device, and the file is closed. In all cases the handle is \r
closed.\r
\r
/**\r
Retrieves the first file from a directory\r
\r
/**\r
Retrieves the first file from a directory\r
\r
- This function opens a directory and gets the first file\92s info in the \r
+ This function opens a directory and gets the first file's info in the \r
directory. Caller can use ShellFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on Buffer.\r
\r
directory. Caller can use ShellFindNextFile() to get other files. When \r
complete the caller is responsible for calling FreePool() on Buffer.\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
if FileHandle is NULL then ASSERT()\r
if Size is NULL then ASSERT()\r
\r
- This function extracts the file size info from the FileHandle\92s EFI_FILE_INFO \r
+ This function extracts the file size info from the FileHandle's EFI_FILE_INFO \r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
data.\r
\r
@param FileHandle file handle from which size is retrieved\r
/**\r
Retreives the current directory path\r
\r
/**\r
Retreives the current directory path\r
\r
- If the DeviceName is NULL, it returns the current device\92s current directory \r
+ If the DeviceName is NULL, it returns the current device's current directory \r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r
name. If the DeviceName is not NULL, it returns the current directory name \r
on specified drive.\r
\r