AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Mention Windows limitations in QFileInfo permission methods

Browse Source 
The limitation is already mentioned in the class documentation, but
IMO is severe enough to be highlighted in the documentation of the
respective methods, too.

Change-Id: I16c68eb41ab9d3a7698d7ef06f747cfd98a8aaff
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Kai Koehne 2015-08-19 14:56:08 +02:00
parent bc867b1794
commit ffbc2d3dc0
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/corelib/io/qfileinfo.cpp
View File

@ -263,6 +263,7 @@ QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request)
groupId(). You can examine a file's permissions and ownership in a groupId(). You can examine a file's permissions and ownership in a
single statement using the permission() function. single statement using the permission() function.
\target NTFS permissions
\note On NTFS file systems, ownership and permissions checking is \note On NTFS file systems, ownership and permissions checking is
disabled by default for performance reasons. To enable it, disabled by default for performance reasons. To enable it,
include the following line: include the following line:
@ -893,6 +894,9 @@ QDir QFileInfo::absoluteDir() const
/*! /*!
Returns \c true if the user can read the file; otherwise returns \c false. Returns \c true if the user can read the file; otherwise returns \c false.
\note If the \l{NTFS permissions} check has not been enabled, the result
on Windows will merely reflect whether the file exists.
\sa isWritable(), isExecutable(), permission() \sa isWritable(), isExecutable(), permission()
*/ */
bool QFileInfo::isReadable() const bool QFileInfo::isReadable() const
@ -911,6 +915,9 @@ bool QFileInfo::isReadable() const
/*! /*!
Returns \c true if the user can write to the file; otherwise returns \c false. Returns \c true if the user can write to the file; otherwise returns \c false.
\note If the \l{NTFS permissions} check has not been enabled, the result on
Windows will merely reflect whether the file is marked as Read Only.
\sa isReadable(), isExecutable(), permission() \sa isReadable(), isExecutable(), permission()
*/ */
bool QFileInfo::isWritable() const bool QFileInfo::isWritable() const
@ -1137,7 +1144,8 @@ QString QFileInfo::readLink() const
returned. returned.
This function can be time consuming under Unix (in the order of This function can be time consuming under Unix (in the order of
milliseconds). milliseconds). On Windows, it will return an empty string unless
the \l{NTFS permissions} check has been enabled.
\sa ownerId(), group(), groupId() \sa ownerId(), group(), groupId()
*/ */
@ -1217,6 +1225,9 @@ uint QFileInfo::groupId() const
On systems where files do not have permissions this function On systems where files do not have permissions this function
always returns \c true. always returns \c true.
\note The result might be inaccurate on Windows if the
\l{NTFS permissions} check has not been enabled.
Example: Example:
\snippet code/src_corelib_io_qfileinfo.cpp 10 \snippet code/src_corelib_io_qfileinfo.cpp 10
@ -1240,6 +1251,9 @@ bool QFileInfo::permission(QFile::Permissions permissions) const
/*! /*!
Returns the complete OR-ed together combination of Returns the complete OR-ed together combination of
QFile::Permissions for the file. QFile::Permissions for the file.
\note The result might be inaccurate on Windows if the
\l{NTFS permissions} check has not been enabled.
*/ */
QFile::Permissions QFileInfo::permissions() const QFile::Permissions QFileInfo::permissions() const
{ {