Version: 3.1.1
#include &wx/filename.h&
encapsulates a file name.
This class serves two purposes: first, it provides the functions to split the file names into components and to recombine these components in the full file name which can then be passed to the OS file functions (and
wrapping them). Second, it includes the functions for working with the files itself. Note that to change the file data you should use
class instead.
provides functions for working with the file attributes.
When working with directory names (i.e. without filename and extension) make sure not to misuse the file name part of this class with the last directory. Instead initialize the
instance like this:
dirname( &C:\mydir&, && );
MyMethod( dirname.GetPath() );
The same can be done using the static method :
dirname = ( &C:\mydir& );
MyMethod( dirname.() );
Accordingly, methods dealing with directories or directory names like
whereas methods dealing with file names like
If it is not known whether a string contains a directory name or a complete file name (such as when interpreting user input) you need to use the static function
(or its identical variants
and ) and construct the
instance accordingly. This will only work if the directory actually exists, of course:
if ((user_input))
fname.( user_input );
fname.( user_input );
Please note that many
methods accept the path format argument which is by wxPATH_NATIVE by default meaning to use the path format native for the current platform. The path format affects the operation of
functions in several ways: first and foremost, it defines the path separator character to use, but it also affects other things such as whether the path has the drive part or not. See wxPathFormat for more info.
File name format
currently supports the file names in the Unix, DOS/Windows, Mac OS and VMS formats. Although these formats are quite different,
tries to treat them all in the same generic way. It supposes that all file names consist of the following parts: the volume (also known as drive under Windows or device under VMS), the path which is a sequence of directory names separated by the path separators and the full filename itself which, in turn, is composed from the base file name and the extension. All of the individual components of the file name may be empty and, for example, the volume name is always empty under Unix, but if they are all empty simultaneously, the filename object is considered to be in an invalid state and
returns false for it.
File names can be case-sensitive or not, the function
allows to determine this. The rules for determining whether the file name is absolute or relative also depend on the file name format and the only portable way to answer this question is to use
Note that on Windows,"X:" refers to the current working directory on drive X. Therefore, a
instance constructed from for example "X:dir/file.ext" treats the portion beyond drive separator as being relative to that directory. To ensure that the filename is absolute, you may use . There is also an inverse function
which undoes what wxFileName::Normalize(wxPATH_NORM_DOTS) does. Other functions returning information about the file format provided by this class are , .
File name construction
You can initialize a
instance using one of the following functions:
File name tests
Before doing other tests, you should use
to verify that the filename is well defined. If it is,
can be used to test whether a file with such name exists and
can be used to test for directory existence. File names should be compared using the
method or . For testing basic access modes, you can use:
File name components
These functions allow to examine and modify the individual directories of the path:
To change the components of the file name individually you can use the following functions:
You can initialize a
instance using one of the following functions:
File name operations
These methods allow to work with the file creation, access and modification times. Note that not all filesystems under all platforms implement these times in the same way. For example, the access time under Windows has a resolution of one day (so it is really the access date and not time). The access time may be updated when the file is executed or not depending on the platform.
Other file system operations functions are:
Library:  Category:  
  (const
&failmsg=(&Not available&), int precision=1,
conv=) const
 Returns the representation of the file size in a human-readable form.
static   (const
&bytes, const
&nullsize=(&Not available&), int precision=1,
 Returns the representation of the file size in a human-readable form.
 Default constructor.
  (const
&filename)
 Copy constructor.
  (const
&fullpath,
 Constructor taking a full filename.
  (const
&path, const
 Constructor a directory name and file name.
  (const
&path, const
&name, const
 Constructor from a directory name, base file name and extension.
  (const
&volume, const
&path, const
&name, const
 Constructor from a volume name, a directory name, base file name and extension.
bool  (const
 Appends a directory component to the path.
void  (const
&filepath)
 Creates the file name from another filename object.
void  (const
&fullpath,
 Creates the file name from a full file name with a path.
void  (const
&volume, const
&path, const
&name, const
&ext, bool hasExt,
 Creates the file name from volume, path, name and extension.
void  (const
&volume, const
&path, const
&name, const
 Creates the file name from volume, path, name and extension.
void  (const
&path, const
 Creates the file name from file path and file name.
void  (const
&path, const
&name, const
 Creates the file name from path, name and extension.
void  (const
 Makes this object refer to the current working directory on the specified volume (or current volume if volume is empty).
void  (const
 Sets this file name object to the given directory name.
void  ()
 Sets this file name object to the home directory.
void  (const
 The function calls
to create a temporary file and sets this object to the name of the file.
void  (const
*fileTemp)
 The function calls
to create a temporary file name and open fileTemp with it.
void  (const
*fileTemp)
 The function calls
to create a temporary file name and open fileTemp with it.
void  ()
 Reset all components to default, uninitialized state.
void  ()
 Removes the extension from the file name resulting in a file name with no trailing dot.
bool  () const
 Returns true if the directory with this name exists.
void  ()
 Turns off symlink dereferencing.
bool  (int flags=wxFILE_EXISTS_ANY) const
 Calls the static overload of this function with the full path of this object.
bool  () const
 Returns true if the file with this name exists.
size_t  () const
 Returns the number of directories in the file name.
&  () const
 Returns the directories in string array form.
  () const
 Returns the file name extension.
  () const
 Returns the full name (including extension but excluding directories).
  ( format=) const
 Returns the full path with name and extension.
  () const
 Return the long form of the path (returns identity on non-Windows platforms).
  () const
 Returns the last time the file was last modified.
  () const
 Returns the name part of the filename (without extension).
  (int flags=wxPATH_GET_VOLUME,
format=) const
 Returns the path part of the filename (without the name or extension).
  ( format=) const
 Returns the path with the trailing separator, useful for appending the name to the given path.
  () const
 Return the short form of the path (returns identity on non-Windows platforms).
  () const
 Returns the size of the file If the file does not exist or its size could not be read (because e.g.
bool  ( *dtAccess,
*dtCreate) const
 Returns the last access, last modification and creation times.
  () const
 Returns the string containing the volume for this file name, empty if it doesn't have one or if the file system doesn't support volumes at all (for example, Unix).
bool  () const
 Returns true if an extension is present.
bool  () const
 Returns true if a name is present.
bool  () const
 Returns true if a volume specifier is present.
bool  (size_t before, const
 Inserts a directory component before the zero-based position in the directory list.
bool  ( format=) const
 Returns true if this filename is absolute.
bool  () const
 Returns true if this object represents a directory, false otherwise (i.e.
bool  () const
 Returns true if the directory component of this instance is an existing directory and this process has read permissions on it.
bool  () const
 Returns true if the directory component of this instance is an existing directory and this process has write permissions on it.
bool  () const
 Returns true if a file with this name exists and if this process has execute permissions on it.
bool  () const
 Returns true if a file with this name exists and if this process has read permissions on it.
bool  () const
 Returns true if a file with this name exists and if this process has write permissions on it.
bool  () const
 Returns true if the filename is valid, false if it is not initialized yet.
bool  ( format=) const
 Returns true if this filename is not absolute.
bool  (const
 Make the file name absolute.
bool  (const
&pathBase=,
 This function tries to put this file name in a form relative to pathBase.
bool  (int perm=, int flags=0) const
 Creates a directory.
bool  (int flags=, const
 Normalize the path.
void  (const
 Prepends a directory to the file path.
void  (size_t pos)
 Removes the specified directory component from the path.
void  ()
 Removes last directory component from the path.
bool  (const
&envname, const
&replacementFmtString=&$%s&, wxPathFormat format=)
 If the path contains the value of the environment variable named envname then this function replaces it with the string obtained from wxString::Format(replacementFmtString, value_of_envname_variable).
bool  ( format=)
 Replaces, if present in the path, the home directory for the given user (see ) with a tilde (~).
bool  (int flags=0) const
 Deletes the specified directory from the file system.
bool  (const
&filepath,
format=) const
 Compares the filename using the rules of this platform.
bool  () const
 Changes the current working directory.
void  ()
 Sets the extension of the file name to be an empty extension.
void  (const
 Sets the extension of the file name.
void  (const
&fullname)
 The full name is the file name and extension (but without the path).
void  (const
 Sets the name part (without extension).
void  (const
 Sets the path.
bool  (int permissions)
 Sets permissions for this file or directory.
bool  (const
*dtAccess, const
*dtMod, const
*dtCreate) const
 Sets the file creation and last access/modification times (any of the pointers may be NULL).
void  (const
 Sets the volume specifier.
bool  () const
 Return whether some operations will follow symlink.
bool  () const
 Sets the access and modification times to the current moment.
bool  (const
&filename) const
 Returns true if the filenames are different.
bool  (const
&filename) const
 Returns true if the filenames are different.
bool  (const
&filename) const
 Returns true if the filenames are equal.
bool  (const
&filename) const
 Returns true if the filenames are equal.
&  (const
&filename)
 Assigns the new value to this filename object.
&  (const
&filename)
 Assigns the new value to this filename object.
static   (const
*fileTemp=NULL)
 Returns a temporary file name starting with the given prefix.
static   (const
*fileTemp=NULL)
 This is the same as
but takes a
parameter instead of .
static bool  (const
 Returns true if the directory with name dir exists.
static   (const
 Returns the object corresponding to the directory with the given name.
static bool  (const
&path, int flags=wxFILE_EXISTS_ANY)
 Returns true if either a file or a directory or something else with this name exists in the file system.
static bool  (const
 Returns true if the file with name file exists.
static   (const
 Returns the file name object corresponding to the given file.
static   (const
 Retrieves the value of the current working directory on the specified volume.
static   ( format=)
 Returns the characters that can't be used in filenames and directory names for the specified format.
static   ( format=)
 Returns the canonical path format for this platform.
static   ()
 Returns the home directory.
static   ( format=)
 Returns the usually used path separator for this format.
static   ( format=)
 Returns the string containing all the path separators for this format.
static   ( format=)
 Returns the string of characters which may terminate the path part.
static   (const
&filename)
 Returns the size of the file If the file does not exist or its size could not be read (because e.g.
static   ()
 Returns the directory used for temporary files, for current user.
static   ( format=)
 Returns the string separating the volume from the path for this format.
static   (char drive, int flags=wxPATH_GET_SEPARATOR)
 This function builds a volume path string, for example "C:\\".
static bool  ( format=)
 Returns true if the file names of this type are case-sensitive.
static bool  (const
 Returns true if the given dir is an existing directory and this process has read permissions on it.
static bool  (const
 Returns true if the given dir is an existing directory and this process has write permissions on it.
static bool  (const
 Returns true if a file with this name exists and if this process has execute permissions on it.
static bool  (const
 Returns true if a file with this name exists and if this process has read permissions on it.
static bool  (const
 Returns true if a file with this name exists and if this process has write permissions on it.
static bool  ( ch,
 Returns true if the char is a path separator for this format.
static bool  (const
 Returns true if the volume part of the path is a unique volume name.
static bool  (const
&dir, int perm=, int flags=0)
 Creates a directory.
static bool  (const
&dir, int flags=0)
 Deletes the specified directory from the file system.
static bool  (const
 Changes the current working directory.
static void  (const
&fullpath,
 Splits the given fullpath into the volume part (which may be empty) and the pure path part, not containing any volume.
static   (const
&fullname)
 Strip the file extension.
static void  (const
&fullpath,
*ext, bool *hasExt=NULL,
 This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
static void  (const
&fullpath,
 This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
static void  (const
&fullpath,
 This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
wxFileName::wxFileName
Default constructor.
wxFileName::wxFileName
Copy constructor.
wxFileName::wxFileName
format =  
Constructor taking a full filename.
If it terminates with a '/', a directory path is constructed (the name will be empty), otherwise a file name and extension are extracted from it.
wxFileName::wxFileName
format =  
Constructor a directory name and file name.
wxFileName::wxFileName
format =  
Constructor from a directory name, base file name and extension.
wxFileName::wxFileName
format =  
Constructor from a volume name, a directory name, base file name and extension.
bool wxFileName::AppendDir
Appends a directory component to the path.
This component should contain a single directory name level, i.e. not contain any path or volume separators nor should it be empty, otherwise the function does nothing and returns false (and generates an assert failure in debug build).
Notice that the return value is only available in wxWidgets 2.9.5 or later.
void wxFileName::Assign
Creates the file name from another filename object.
void wxFileName::Assign
format =  
Creates the file name from a full file name with a path.
void wxFileName::Assign
bool 
format =  
Creates the file name from volume, path, name and extension.
void wxFileName::Assign
format =  
Creates the file name from volume, path, name and extension.
void wxFileName::Assign
format =  
Creates the file name from file path and file name.
void wxFileName::Assign
format =  
Creates the file name from path, name and extension.
void wxFileName::AssignCwd
volume = )
Makes this object refer to the current working directory on the specified volume (or current volume if volume is empty).
void wxFileName::AssignDir
format =  
Sets this file name object to the given directory name.
The name and extension will be empty.
void wxFileName::AssignHomeDir
Sets this file name object to the home directory.
void wxFileName::AssignTempFileName
The function calls
to create a temporary file and sets this object to the name of the file.
If a temporary file couldn't be created, the object is put into an invalid state (see ).
void wxFileName::AssignTempFileName
fileTemp 
The function calls
to create a temporary file name and open fileTemp with it.
If the file couldn't be opened, the object is put into an invalid state (see ).
void wxFileName::AssignTempFileName
fileTemp 
The function calls
to create a temporary file name and open fileTemp with it.
If the file couldn't be opened, the object is put into an invalid state (see ).
void wxFileName::Clear
Reset all components to default, uninitialized state.
void wxFileName::ClearExt
Removes the extension from the file name resulting in a file name with no trailing dot.
wxFileName::CreateTempFileName
fileTemp = NULL 
Returns a temporary file name starting with the given prefix.
If prefix is an absolute path and ends in a separator, the temporary file is creat if it is an absolute filepath or there is no separator, the temporary file is created in its path, with the 'name' segment prepended to th otherwise it is created in the default system directory for temporary files or in the current directory.
If the function succeeds, the temporary file is actually created. If fileTemp is not NULL, this
will be opened using the name of the temporary file. Where possible this is done in an atomic way to ensure that no race condition occurs between creating the temporary file name and opening it, which might lead to a security compromise on multiuser systems. If fileTemp is NULL, the file is created but not opened. Under Unix, the temporary file will have read and write permissions for the owner only, to minimize security problems.
Parameters
prefixLocation to use for the temporary file name construction. If prefix is a directory it must have a terminal separator
fileTempThe file to open, or NULL just to get the name
ReturnsThe full temporary filepath, or an empty string on error.
wxFileName::CreateTempFileName
fileTemp = NULL 
This is the same as
but takes a
parameter instead of .
bool wxFileName::DirExists
Returns true if the directory with this name exists.
Notice that this function tests the directory part of this object, i.e. the string returned by , and not the full path returned by .
static bool wxFileName::DirExists
Returns true if the directory with name dir exists.
wxFileName::DirName
format =  
Returns the object corresponding to the directory with the given name.
The dir parameter may have trailing path separator or not.
void wxFileName::DontFollowLink
Turns off symlink dereferencing.
By default, all operations in this class work on the target of a symbolic link (symlink) if the path of the file is actually a symlink. Using this method allows to turn off this "symlink following" behaviour and apply the operations to this path itself, even if it is a symlink.
The following methods are currently affected by this option:
as there is no portable way to change the time of symlink itself).
Existence checks: ,
(notice that static versions of these methods always follow symlinks).
IsSameAs().
Since2.9.5
bool wxFileName::Exists
flags = wxFILE_EXISTS_ANY)
Calls the static overload of this function with the full path of this object.
Since2.9.4 (flags is new since 2.9.5)
static bool wxFileName::Exists
flags = wxFILE_EXISTS_ANY 
Returns true if either a file or a directory or something else with this name exists in the file system.
Don't dereference path if it is a symbolic link and flags argument contains .
This method is equivalent to() || ()
under Windows, but under Unix it also returns true if the file identifies a special file system object such as a device, a socket or a FIFO.
Alternatively you may check for the existence of a file system entry of a specific type by passing the appropriate flags (this parameter is new since wxWidgets 2.9.5). E.g. to test for a symbolic link existence you could use .
Since2.9.4
bool wxFileName::FileExists
Returns true if the file with this name exists.
static bool wxFileName::FileExists
Returns true if the file with name file exists.
wxFileName::FileName
format =  
Returns the file name object corresponding to the given file.
This function exists mainly for symmetry with .
wxFileName::GetCwd
volume = )
Retrieves the value of the current working directory on the specified volume.
If the volume is empty, the program's current working directory is returned for the current volume.
ReturnsThe string containing the current working directory or an empty string on error.
size_t wxFileName::GetDirCount
Returns the number of directories in the file name.
const & wxFileName::GetDirs
Returns the directories in string array form.
wxFileName::GetExt
Returns the file name extension.
wxFileName::GetForbiddenChars
format = )
Returns the characters that can't be used in filenames and directory names for the specified format.
wxFileName::GetFormat
format = )
Returns the canonical path format for this platform.
wxFileName::GetFullName
Returns the full name (including extension but excluding directories).
wxFileName::GetFullPath
format = )
Returns the full path with name and extension.
wxFileName::GetHomeDir
Returns the home directory.
wxFileName::GetHumanReadableSize
failmsg = (&Not available&),
precision = 1,
conv =  
Returns the representation of the file size in a human-readable form.
In the first version, the size of this file is used. In the second one, the specified size bytes is used.
If the file size could not be retrieved or bytes is
or zero, the failmsg string is returned.
Otherwise the returned string is a floating-point number with precision decimal digits followed by the abbreviation of the unit used. By default the traditional, although incorrect, convention of using SI units for multiples of 1024 is used, i.e. returned string will use suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes, gigabytes and terabytes respectively. With the IEC convention the names of the units are changed to B, KiB, MiB, GiB and TiB for bytes, kibibytes, mebibytes, gibibytes and tebibytes. Finally, with SI convention the same B, KB, MB, GB and TB suffixes are used but in their correct SI meaning, i.e. as multiples of 1000 and not 1024.
Support for the different size conventions is new in wxWidgets 2.9.1, in previous versions only the traditional convention was implemented.
wxFileName::GetHumanReadableSize
nullsize = (&Not available&),
precision = 1,
conv =  
Returns the representation of the file size in a human-readable form.
In the first version, the size of this file is used. In the second one, the specified size bytes is used.
If the file size could not be retrieved or bytes is
or zero, the failmsg string is returned.
Otherwise the returned string is a floating-point number with precision decimal digits followed by the abbreviation of the unit used. By default the traditional, although incorrect, convention of using SI units for multiples of 1024 is used, i.e. returned string will use suffixes of B, KB, MB, GB, TB for bytes, kilobytes, megabytes, gigabytes and terabytes respectively. With the IEC convention the names of the units are changed to B, KiB, MiB, GiB and TiB for bytes, kibibytes, mebibytes, gibibytes and tebibytes. Finally, with SI convention the same B, KB, MB, GB and TB suffixes are used but in their correct SI meaning, i.e. as multiples of 1000 and not 1024.
Support for the different size conventions is new in wxWidgets 2.9.1, in previous versions only the traditional convention was implemented.
wxFileName::GetLongPath
Return the long form of the path (returns identity on non-Windows platforms).
wxFileName::GetModificationTime
Returns the last time the file was last modified.
wxFileName::GetName
Returns the name part of the filename (without extension).
wxFileName::GetPath
flags = wxPATH_GET_VOLUME,
format =  
Returns the path part of the filename (without the name or extension).
The possible flags values are:
wxPATH_GET_VOLUME: Return the path with the volume (does nothing for the filename formats without volumes), otherwise the path without volume part is returned.
wxPATH_GET_SEPARATOR: Return the path with the trailing separator, if this flag is not given there will be no separator at the end of the path.
wxPATH_NO_SEPARATOR: Don't include the trailing separator in the returned string. This is the default (the value of this flag is 0) and exists only for symmetry with wxPATH_GET_SEPARATOR.
NoteIf the path is a toplevel one (e.g. "/" on Unix or "C:\" on Windows), then the returned path will contain trailing separator even with wxPATH_NO_SEPARATOR.
wxFileName::GetPathSeparator
format = )
Returns the usually used path separator for this format.
For all formats but wxPATH_DOS there is only one path separator anyhow, but for DOS there are two of them and the native one, i.e. the backslash is returned by this method.
wxFileName::GetPathSeparators
format = )
Returns the string containing all the path separators for this format.
For all formats but wxPATH_DOS this string contains only one character but for DOS and Windows both '/' and '\' may be used as separators.
wxFileName::GetPathTerminators
format = )
Returns the string of characters which may terminate the path part.
This is the same as
except for VMS path format where ] is used at the end of the path part.
wxFileName::GetPathWithSep
format = )
Returns the path with the trailing separator, useful for appending the name to the given path.
This is the same as calling (wxPATH_GET_VOLUME | wxPATH_GET_SEPARATOR, format)
wxFileName::GetShortPath
Return the short form of the path (returns identity on non-Windows platforms).
wxFileName::GetSize
Returns the size of the file If the file does not exist or its size could not be read (because e.g.
the file is locked by another process) the returned value is .
wxFileName::GetSize
Returns the size of the file If the file does not exist or its size could not be read (because e.g.
the file is locked by another process) the returned value is .
wxFileName::GetTempDir
Returns the directory used for temporary files, for current user.
bool wxFileName::GetTimes
dtCreate 
Returns the last access, last modification and creation times.
The last access time is updated whenever the file is read or written (or executed in the case of Windows), last modification time is only changed when the file is written to. Finally, the creation time is indeed the time when the file was created under Windows and the inode change time under Unix (as it is impossible to retrieve the real file creation time there anyhow) which can also be changed by many operations after the file creation.
If no filename or extension is specified in this instance of
(and therefore
returns true) then this function will return the directory times of the path specified by , otherwise the file times of the file specified by . Any of the pointers may be NULL if the corresponding time is not needed.
Returnstrue on success, false if we failed to retrieve the times.
wxFileName::GetVolume
Returns the string containing the volume for this file name, empty if it doesn't have one or if the file system doesn't support volumes at all (for example, Unix).
wxFileName::GetVolumeSeparator
format = )
Returns the string separating the volume from the path for this format.
wxFileName::GetVolumeString
char 
flags = wxPATH_GET_SEPARATOR 
This function builds a volume path string, for example "C:\\".
Implemented for the platforms which use drive letters, i.e. MSW only.
Since2.9.0
Parameters
driveThe drive letter, 'A' through 'Z' or 'a' through 'z'.
flagswxPATH_NO_SEPARATOR or wxPATH_GET_SEPARATOR to omit or include the trailing path separator, the default is to include it.
ReturnsVolume path string.
bool wxFileName::HasExt
Returns true if an extension is present.
bool wxFileName::HasName
Returns true if a name is present.
bool wxFileName::HasVolume
Returns true if a volume specifier is present.
bool wxFileName::InsertDir
size_t 
Inserts a directory component before the zero-based position in the directory list.
As with , dir must be a single directory name and the function returns false and does nothing else if it isn't.
Notice that the return value is only available in wxWidgets 2.9.5 or later.
bool wxFileName::IsAbsolute
format = )
Returns true if this filename is absolute.
static bool wxFileName::IsCaseSensitive
format = )
Returns true if the file names of this type are case-sensitive.
bool wxFileName::IsDir
Returns true if this object represents a directory, false otherwise (i.e.
if it is a file).
Note that this method doesn't test whether the directory or file really exists, you should use
bool wxFileName::IsDirReadable
Returns true if the directory component of this instance is an existing directory and this process has read permissions on it.
Read permissions on a directory mean that you can list the directory contents but it doesn't imply that you have read permissions on the files contained.
static bool wxFileName::IsDirReadable
Returns true if the given dir is an existing directory and this process has read permissions on it.
Read permissions on a directory mean that you can list the directory contents but it doesn't imply that you have read permissions on the files contained.
bool wxFileName::IsDirWritable
Returns true if the directory component of this instance is an existing directory and this process has write permissions on it.
Write permissions on a directory mean that you can create new files in the directory.
static bool wxFileName::IsDirWritable
Returns true if the given dir is an existing directory and this process has write permissions on it.
Write permissions on a directory mean that you can create new files in the directory.
bool wxFileName::IsFileExecutable
Returns true if a file with this name exists and if this process has execute permissions on it.
static bool wxFileName::IsFileExecutable
Returns true if a file with this name exists and if this process has execute permissions on it.
bool wxFileName::IsFileReadable
Returns true if a file with this name exists and if this process has read permissions on it.
static bool wxFileName::IsFileReadable
Returns true if a file with this name exists and if this process has read permissions on it.
bool wxFileName::IsFileWritable
Returns true if a file with this name exists and if this process has write permissions on it.
static bool wxFileName::IsFileWritable
Returns true if a file with this name exists and if this process has write permissions on it.
static bool wxFileName::IsMSWUniqueVolumeNamePath
format =  
Returns true if the volume part of the path is a unique volume name.
This function will always return false if the path format is not wxPATH_DOS.
Unique volume names are Windows volume identifiers which remain the same regardless of where the volume is actually mounted. Example of a path using a volume name could be \\?\Volume{-d0ac-11db-9dd0-806d6172696f}\Program Files\setup.exe
Since2.9.1
bool wxFileName::IsOk
Returns true if the filename is valid, false if it is not initialized yet.
The assignment functions and
may reset the object to the uninitialized, invalid state (the former only do it on failure).
static bool wxFileName::IsPathSeparator
format =  
Returns true if the char is a path separator for this format.
bool wxFileName::IsRelative
format = )
Returns true if this filename is not absolute.
bool wxFileName::MakeAbsolute
format =  
Make the file name absolute.
This is a shortcut for ( |
, cwd, format)
See also, ,
bool wxFileName::MakeRelativeTo
pathBase = ,
format =  
This function tries to put this file name in a form relative to pathBase.
In other words, it returns the file name which should be used to access this file if the current directory were pathBase.
Parameters
pathBaseThe directory to use as root, current directory is used by default
formatThe file name format, native by default
Returnstrue if the file name has been changed, false if we failed to do anything with it (currently this only happens if the file name is on a volume different from the volume specified by pathBase).
bool wxFileName::Mkdir
flags = 0 
Creates a directory.
Parameters
permThe permissions for the newly created directory. See the
enumeration for more info.
flagsIf the flags contain wxPATH_MKDIR_FULL flag, try to create each directory in the path and also don't return an error if the target directory already exists.
ReturnsReturns true if the directory was successfully created, false otherwise.
static bool wxFileName::Mkdir
flags = 0 
Creates a directory.
Parameters
dirThe directory to create
permThe permissions for the newly created directory. See the
enumeration for more info.
flagsIf the flags contain wxPATH_MKDIR_FULL flag, try to create each directory in the path and also don't return an error if the target directory already exists.
ReturnsReturns true if the directory was successfully created, false otherwise.
bool wxFileName::Normalize
format =  
Normalize the path.
With the default flags value, the path will be made absolute, without any ".." and "." and all environment variables will be expanded in it.
Notice that in some rare cases normalizing a valid path may result in an invalid
object. E.g. normalizing "./" path using wxPATH_NORM_DOTS but not wxPATH_NORM_ABSOLUTE will result in a completely empty and thus invalid object. As long as there is a non empty file name the result of normalization will be valid however.
Parameters
flagsThe kind of normalization to do with the file name. It can be any or-combination of the
enumeration values.
cwdIf not empty, this directory will be used instead of current working directory in normalization (see wxPATH_NORM_ABSOLUTE).
formatThe file name format to use when processing the paths, native by default.
Returnstrue if normalization was successfully or false otherwise.
bool wxFileName::operator!=
Returns true if the filenames are different.
The string filenames is interpreted as a path in the native filename format.
bool wxFileName::operator!=
Returns true if the filenames are different.
The string filenames is interpreted as a path in the native filename format.
& wxFileName::operator=
Assigns the new value to this filename object.
& wxFileName::operator=
Assigns the new value to this filename object.
bool wxFileName::operator==
Returns true if the filenames are equal.
The string filenames is interpreted as a path in the native filename format.
bool wxFileName::operator==
Returns true if the filenames are equal.
The string filenames is interpreted as a path in the native filename format.
void wxFileName::PrependDir
Prepends a directory to the file path.
Please see
for important notes.
void wxFileName::RemoveDir
size_t 
Removes the specified directory component from the path.
void wxFileName::RemoveLastDir
Removes last directory component from the path.
bool wxFileName::ReplaceEnvVariable
replacementFmtString = &$%s&,
format =  
If the path contains the value of the environment variable named envname then this function replaces it with the string obtained from wxString::Format(replacementFmtString, value_of_envname_variable).
This function is useful to make the path shorter or to make it dependent from a certain environment variable.
with wxPATH_NORM_ENV_VARS can perform the opposite of this function (depending on the value of replacementFmtString).
The name and extension of this filename are not modified.
fn(&/usr/openwin/lib/someFile&);
fn.ReplaceEnvVariable(&OPENWINHOME&);
Since2.9.0
Returnstrue if the operation was successful (which doesn't mean that something was actually replaced, just that
didn't fail).
bool wxFileName::ReplaceHomeDir
format = )
Replaces, if present in the path, the home directory for the given user (see ) with a tilde (~).
with wxPATH_NORM_TILDE performs the opposite of this function.
The name and extension of this filename are not modified.
Since2.9.0
Returnstrue if the operation was successful (which doesn't mean that something was actually replaced, just that
didn't fail).
bool wxFileName::Rmdir
flags = 0)
Deletes the specified directory from the file system.
Parameters
flagsCan contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By default contains neither so the directory will not be removed unless it is empty.
ReturnsReturns true if the directory was successfully deleted, false otherwise.
static bool wxFileName::Rmdir
flags = 0 
Deletes the specified directory from the file system.
Parameters
dirThe directory to delete
flagsCan contain one of wxPATH_RMDIR_FULL or wxPATH_RMDIR_RECURSIVE. By default contains neither so the directory will not be removed unless it is empty.
ReturnsReturns true if the directory was successfully deleted, false otherwise.
bool wxFileName::SameAs
format =  
Compares the filename using the rules of this platform.
bool wxFileName::SetCwd
Changes the current working directory.
static bool wxFileName::SetCwd
Changes the current working directory.
void wxFileName::SetEmptyExt
Sets the extension of the file name to be an empty extension.
This is different from having no extension at all as the file name will have a trailing dot after a call to this method.
void wxFileName::SetExt
Sets the extension of the file name.
Setting an empty string as the extension will remove the extension resulting in a file name without a trailing dot, unlike a call to .
void wxFileName::SetFullName
The full name is the file name and extension (but without the path).
void wxFileName::SetName
Sets the name part (without extension).
void wxFileName::SetPath
format =  
Sets the path.
The path argument includes both the path and the volume, if supported by format.
Calling this function doesn't affect the name and extension components, to change them as well you can use
or just an assignment operator.
bool wxFileName::SetPermissions
permissions)
Sets permissions for this file or directory.
Parameters
permissionsThe new permissions: this should be a combination of
enum elements.
NoteIf this is a symbolic link and it should not be followed this call will fail.
Returnstrue on success, false if an error occurred (for example, the file doesn't exist).
bool wxFileName::SetTimes
dtCreate 
Sets the file creation and last access/modification times (any of the pointers may be NULL).
Notice that the file creation time can't be changed under Unix, so dtCreate is ignored there (but true is still returned). Under Windows all three times can be set.
void wxFileName::SetVolume
Sets the volume specifier.
bool wxFileName::ShouldFollowLink
Return whether some operations will follow symlink.
By default, file operations "follow symlink", i.e. operate on its target and not on the symlink itself. See
for more information.
Since2.9.5
static void wxFileName::SplitPath
bool * 
hasExt = NULL,
format =  
This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
Any of the output parameters (volume, path, name or ext) may be NULL if you are not interested in the value of a particular component. Also, fullpath may be empty on entry. On return, path contains the file path (without the trailing separator), name contains the file name and ext contains the file extension without leading dot. All three of them may be empty if the corresponding component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not NULL).
Note that for a filename "foo." the extension is present, as indicated by the trailing dot, but empty. If you need to cope with such cases, you should use hasExt instead of relying on testing whether ext is empty or not.
static void wxFileName::SplitPath
format 
This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
Any of the output parameters (volume, path, name or ext) may be NULL if you are not interested in the value of a particular component. Also, fullpath may be empty on entry. On return, path contains the file path (without the trailing separator), name contains the file name and ext contains the file extension without leading dot. All three of them may be empty if the corresponding component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not NULL).
Note that for a filename "foo." the extension is present, as indicated by the trailing dot, but empty. If you need to cope with such cases, you should use hasExt instead of relying on testing whether ext is empty or not.
static void wxFileName::SplitPath
format =  
This function splits a full file name into components: the volume (with the first version) path (including the volume in the second version), the base name and the extension.
Any of the output parameters (volume, path, name or ext) may be NULL if you are not interested in the value of a particular component. Also, fullpath may be empty on entry. On return, path contains the file path (without the trailing separator), name contains the file name and ext contains the file extension without leading dot. All three of them may be empty if the corresponding component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not NULL).
Note that for a filename "foo." the extension is present, as indicated by the trailing dot, but empty. If you need to cope with such cases, you should use hasExt instead of relying on testing whether ext is empty or not.
static void wxFileName::SplitVolume
format =  
Splits the given fullpath into the volume part (which may be empty) and the pure path part, not containing any volume.
wxFileName::StripExtension
Strip the file extension.
This function does more than just removing everything after the last period from the string, for example it will return the string ".vimrc" unchanged because the part after the period is not an extension but the file name in this case. You can use
to really get just the part before the last period (but notice that that function returns empty string if period is not present at all unlike this function which returns the fullname unchanged in this case).
Parameters
fullnameFile path including name and, optionally, extension.
ReturnsFile path without extension
Since2.9.0
bool wxFileName::Touch
Sets the access and modification times to the current moment.