]> git.saurik.com Git - wxWidgets.git/commitdiff
Clarify that wxFileSystem::OpenFile() takes URL, not filename.
authorVáclav Slavík <vslavik@fastmail.fm>
Thu, 6 May 2010 18:28:31 +0000 (18:28 +0000)
committerVáclav Slavík <vslavik@fastmail.fm>
Thu, 6 May 2010 18:28:31 +0000 (18:28 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64239 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/filesys.h

index bc311541f5a6439550fe5e9d820737ff081efa0b..eb116eabcd2ae1b54649745a96c30dc660e08b70 100644 (file)
@@ -160,6 +160,11 @@ public:
         Passing @e "wxFS_READ | wxFS_SEEKABLE" for @a flags will back
         a stream that is not natively seekable with memory or a file
         and return a stream that is always seekable.
+
+        @note
+        The @a location argument is, despite this method's name @em not
+        a filename. It is a "location", aka wxFileSystem URL (see
+        @ref overview_fs).
     */
     wxFSFile* OpenFile(const wxString& location,
                        int flags = wxFS_READ);