Public Types

The different types of path names.

This type indicates the syntax of a path name when it is translated into a string. In particular, it decides whether the directory separator character should be a slash, as on Unix, or a backslash, as on DOS.

Path names sorting options.

Higher-level objets can sort IlPathName objects. This enumeration allows for customizing how this sort is performed.

Initializes an empty IlPathname object.

All the fields are empty.

See also

IlPathName(const IlString&), IlPathName(const char*), IlPathName(const IlPathName&).

Initializes an IlPathname object from an IlString.

The string is parsed to initialize a new IlPathname the way you would expect: relative path names are resolved, empty segments are removed, and so on.

Example, on a Windows machine:

Parameters

path	The path that initializes this object.

See also

IlPathName(), IlPathName(const char*), IlPathName(const IlPathName&).

Initializes an IlPathname object from a C-style string.

The string is copied.

Parameters

path	The path that initializes this object.

See also

IlPathName(), IlPathName(const IlString&), IlPathName(const IlPathName&).

Copy constructor.

Parameters

path	The source path name that is copied.

See also

IlPathName(), IlPathName(const IlString&), IlPathName(const char*).

Appends a directory to this IlPathName.

directory must be a relative path (not beginning with a directory separator), or the result is undefined.

Example, on a Windows machine:

Parameters

directory	The directory to append to the current path name.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
type	The syntax (system, Unix or DOS) that the provided string is using. The default is SystemPathType.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

getDirectory().

Appends a directory to this IlPathName.

directory must be a relative path (not beginning with a backslash character), and in the DOS syntax or the result is undefined.

Parameters

directory	The directory to append to the current path name.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

addDirectory(), addUnixDirectory().

getDosDirectory().

Appends a directory to this IlPathName.

directory must be a relative path (not beginning with a slash character), and in the Unix syntax or the result is undefined.

Parameters

directory	The directory to append to the current path name.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

addDirectory(), addDosDirectory().

getUnixDirectory().

Changes the current directory to this path name.

Returns

IlFalse if an error occurs and IlTrue if the operation is successful.

See also

QueryCurrentDirectory() queryCurrentDirectory().

Changes permissions of the object referenced by this IlPathName.

The value depends on the system. If an error occurs, then the functions returns IlFalse, IlTrue otherwise.

Parameters

newMode

The new mode that is set to the object referenced by this path name object, as defined in the "C" function chmod.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

queryMode().

Closes this IlPathName.

The current path name must have been opened using openDir() before this method is invoked. When this method returns, you must not invoke readDir() or rewindDir any more.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

openDir(), readDir(), rewindDir().

Replaces this IlPathName by its directory part, except the last level.

The file name part is dropped from this object.
If the directory part has no sub-directory (it refers to a device root directory) then it is not modified.

Example, on a Windows machine:

Returns

The resulting IlPathName object.

Computes the part that is different from the beginning of two path names.

This method stores the part of the two path names that in common, the the end of them.

Example, on a Windows machine:

Parameters

path	The path name to compare with.

Returns

The current, modified object.

See also

computeDifferTrailing().

computeSameLeading().

Computes the part that is different from the beginning of two path names.

This method stores the part of the two path names that in common, at the end of them.

Example, on a Windows machine:

Parameters

path	The path name to compare with.

Returns

The current, modified object.

See also

computeDifferLeading().

computeSameTrailing().

Query the top-most directory of this IlPathName.

Example, on a Windows machine:

Returns

The current, modified object.

See also

computeLastSubDirectory().

Query the bottom-most directory of this IlPathName.

Example, on a Windows machine:

Returns

The current, modified object.

See also

computeFirstSubDirectory().

Computes the number of levels of the current path.

This value is the number of sub-directories this IlPathName is made of.

Returns

The number of sub-directories stored in this object.

See also

getTruncatedValue().

Computes the relative path of the current path name, relative to another IlPathName.

The current object is assigned a relative path that is such that if it were appended to path, the resulting value would be the initial value of the current path name object.

Example, on a Windows machine:

Parameters

path	The path name to compute the relative path from. Note that this must be a directory (its value should end with a directory separator).

Returns

The resulting IlPathName object, that holds the computed relative path.

Computes the part that is common at the beginning of two path names.

Example, on a Windows machine:

Parameters

path	The path name to compare with.

Returns

The current, modified object.

See also

computeSameTrailing().

computeDifferLeading().

Computes the part that is common at the end of two path names.

Example, on a Windows machine:

Parameters

path	The path name to compare with.

Returns

The current, modified object.

See also

computeSameLeading().

computeDifferLeading().

Returns a copy of the content of this IlPathname, truncated to 8.3 names, in the DOS syntax.

This method is equivalent to get83DosValue().copyValue();.

This method builds a SFN version of the current path name, in the DOS syntax. If the path name is empty, it returns .\.

Note: The truncation is actually the result of removing the trailing characters of each part of the path name, if necessary. It leaves a maximum of eight characters for each part, and three characters for the extension part. This does not follow the SFN specification (see the 8.3 filename article on Wikipedia.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains an SFN-like version of this path name.

See also

get83DosValue(), getDosValue().

Returns a copy of the file name and the extension parts of this IlPathname.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the file name and the extension parts of this path name.

See also

getBaseName().

Returns a copy of the device part of this IlPathname.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the device part of this path name.

See also

getDevice().

Returns a copy of the directory part of this IlPathname.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Parameters

finalSep	If IlTrue (which is the default), a final directory separator is added to the returned value.
type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

A new C-style string, allocated with new[], that contains the device part of this path name.

See also

getDirectory().

Returns a copy of the device and directory parts of this IlPathname.

The two parts are concatenated.
Note that in the Unix form of the path names, the device part is always empty.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Parameters

finalSep	If IlTrue (which is the default), a final directory separator is added to the returned value.
type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

A new C-style string, allocated with new[], that contains the concatenation of the device and the directory parts of this path name.

See also

getDirName().

Returns a copy of the directory part of this IlPathname in the DOS syntax.

This method is equivalent to copyDirectory(finalSep, DosPathType);.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Parameters

finalSep

If IlTrue (which is the default), a final backslash character is added to the returned value.

Returns

A new C-style string, allocated with new[], that contains the directory part of this path name.

See also

copyDirectory(), getDosDirectory().

Returns a copy of the content of this IlPathname in the DOS syntax.

This method is equivalent to copyValue(DosPathType);.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the representation of this path name.

See also

copyValue(), getDosValue().

Returns a copy of the extension part of this IlPathname.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the extension part of this path name.

See also

getExtension().

Returns a copy of the file name part of this IlPathname.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the file name of this path name.

See also

getFileName().

Returns a copy of the directory part of this IlPathname in the Unix syntax.

This method is equivalent to copyDirectory(finalSep, UnixPathType);.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Parameters

finalSep

If IlTrue (which is the default), a final slash character is added to the returned value.

Returns

A new C-style string, allocated with new[], that contains the directory part of this path name.

See also

copyDirectory(), getUnixDirectory().

Returns a copy of the content of this IlPathname in the Unix syntax.

This method is equivalent to copyValue(UnixPathType);.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Returns

A new C-style string, allocated with new[], that contains the representation of this path name.

See also

copyValue(), getUnixValue().

Returns a copy of the whole path name stored of this IlPathname.

If the path name is empty, this returns "." followed by the requested directory separator.

Warning

The returned string must be deleted with the delete[] operator when it is not used any more.

Parameters

type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

A new C-style string, allocated with new[], that contains the concatenation of the the whole contentof this path name.

See also

getString().

Physically creates a file or a directory corresponding to this IlPathName.

You can specify the creation mode, at it is defined in the "C" function chmod.

Parameters

mode	The creation mode for this file system object. The default value of -1 indicates that the default mode (as specified by umask on Unix systems) must be used.
recursive	If set to IlTrue, which is the default, then the entire directory structure will be created as neeeded to create the indicated file system object. Set this to IlFalse not to create this structure, and potentially fail to create the final object if the hierarchy does not exist.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

remove(), changeMode().

Tests if this path name physically exists.

Returns

IlTrue if the path name actually exists on the file system, and IlFalse otherwise.

See also

doesExist(const IlString&).

isReadable().

Tests if a path name physically exists.

Parameters

pathname

The path name to test. This must be in the system syntax.

Returns

IlTrue if the referenced path actually exists on the file system and IlFalse otherwise.

See also

doesExist().

isReadable(const IlString& pathname), isWritable(const IlString&), isExecutable(const IlString&).

Transforms to an absolute path name.

If the current path name is not an absolute pathname, this method prepends a directory separator in front its whole directory part.

See also

forceRelative().

Transforms to a directory.

The file name and extension parts become the final part of the directory part.

Transforms to a relative path name.

If the current path name is an absolute pathname, this method removes the directory separator in front its whole directory part.

Returns the short pathname version of this IlPathname.

This method builds a SFN (Short File Name)version of the current path name, in the DOS syntax. If the path name is empty, it returns .\.

Note: The truncation is actually the result of removing the trailing characters of each part of the path name, if necessary. It leaves a maximum of eight characters for each part, and three characters for the extension part. This does not follow the SFN specification (see the 8.3 filename article on Wikipedia), but has similar consequences.

Example, on a Windows machine:

Returns

An SFN-like version of this path name.

See also

getDosValue(), copy83DosValue().

Returns the base file name of this path name.

The Example, on a Windows machine:

Returns

The base file name of this object.

See also

setBaseName().

copyBaseName().

getFileName(), getExtension().

Returns the device part of this IlPathname.

On a Windows platform, this method returns the drive letter of the path name.

Example, on a Windows machine:

Returns

The device part of this object.

See also

setDevice(), copyDevice().

Returns the directory part of this IlPathname.

Example, on a Windows machine:

Parameters

finalSep	If IlTrue (which is the default), a final directory separator is added to the returned value.
type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

The directory part of this object.

See also

setDirectory(), getDirName(), copyDirectory().

Returns the device and directory parts of this IlPathname.

The two parts are concatenated.
Note that in the Unix form of the path names, the device part is always empty.

Example, on a Windows machine:

Parameters

finalSep	If IlTrue (which is the default), a final directory separator is added to the returned value.
type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

The concatenation of the device and directory parts of this object.

See also

setDirName(const IlString&, int, IlPathType, int), getDevice(), copyDirName().

Returns the directory part of this IlPathname, with the DOS syntax.

Parameters

finalSep

If IlTrue, the returned string ends with a backslash ('\') character.

Returns

The directory part of this object, using the DOS directory separator backslash ('\').

See also

getDirectory().

Returns the whole path name stored in this IlPathname, with the DOS mode.

If the path name is empty, it returns ".\\".

Returns

The whole path name stored in this object, using the DOS directory separator backslash ('\').

See also

getString().

Returns the extension part of this path name.

Example, on a Windows machine:

Returns

The extension part of this object.

See also

setExtension() getBaseName().

Returns the file name part of this path name.

Example, on a Windows machine:

Returns

The file name part of this object.

See also

setFileName(), getBaseName().

Returns the whole path name stored in this IlPathname.

If the path name is empty, this returns "." followed by the requested directory separator.

Parameters

type	The syntax (system, Unix or DOS) that you want returned. The default is SystemPathType.

Returns

The whole path name stored in this object.

See also

setValue().

copyValue().

getFileName(), getExtension(), getDevice(), getDirectory(),

Returns a part of the sub-directories of the path.

This methods collects a series of successive sub-directories in the current path name object, and returns them using the current system syntax.

Example, on a Windows machine:

Parameters

level	The starting sub-directory level into the path, starting at 1. If level is a negative value, this method will start collecting the sub-directories from the end (-1 indicates the last sub-directory of the path name).
count	The number of sub-directories that are collected. If this value is 0, the empty string is returned. If this value is negative, every sub-directory after level will be collected.

Returns

The requested sub-path.

Returns a partial representation of the directory part of this IlPathname, showing only the last sub-directories.

The returns string contains the path name in the system syntax, but with only, at most, the last level sub-directories. If the path name contains more than level sub-directories, then the first sub-directory names are replaced by an ellipsis ("...").

If level is greater than the number of sub-directories in the current path name, then this method is equivalent to:

Example, on a Windows machine:

Parameters

level

How many sub-directories the result string contains. The default value is 2.

Returns

A string that represents this object, but containing only the last level sub-directories.

See also

getString().

Returns the directory part of this IlPathname, with the Unix syntax.

Parameters

finalSep

If IlTrue, the returned string ends with a slash ('/') character.

Returns

The directory part of this object, using the Unix directory separator slash ('/').

See also

getDirectory().

Returns the whole path name stored in this IlPathname, with the Unix syntax.

If the path name is empty, it returns "./".

Returns

The whole path name stored in this object, using the Unix directory separator slash ('/').

See also

getString().

Tests if this path name is an absolute path.

Returns

IlTrue if this object is an absolute path and IlFalse otherwise.

Tests if this object is the current directory.

Returns

IlTrue if the path name is a directory and the directory part is ., and IlFalse otherwise.

See also

isInCurrentDirectory().

Tests if this path name is a directory.

An IlPathName is a directory if it has is no file name and no extension.

Returns

IlTrue if this object is a directory and IlFalse otherwise.

See also

isSubDirectory().

Tests if the current path name is empty.

Returns

IlTrue if the path is empty, that is all the parts of the path name are empty, and IlFalse otherwise.

Tests if this object has no directory part.

Returns

IlTrue if this path has an empty directory part, and IlFalse otherwise.

Tests if this path name refers to an object that can be executed.

Returns

IlTrue if the path name refers to an object that is executable, and IlFalse otherwise.

See also

isExecutable(const IlString&).

doesExist(), isReadable(), isWritable().

Tests if a path name has the execution permission set for the current user.

Parameters

pathname

The path name to test. This must be in the system syntax.

Returns

IlTrue if the referenced path exists and has the execution permission for the current user and IlFalse otherwise.

See also

isExecutable().

doesExist(const IlString&), isReadable(const IlString&), isWritable(const IlString&).

Tests if this object is in the current directory.

Returns

Returns IlTrue if the directory part is . (the current directory), and IlFalse otherwise.

See also

isCurrentDirectory(), isSubDirectory().

Tests if a file system object is newer than the one referenced by this IlPathName.

A file system is newer than another if it has been modified more recently than the other.

Parameters

path	The path name object to compare the last modification with.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

queryModificationTime().

Tests if this path name refers to an object that can be read from.

Returns

IlTrue if the path name refers to an object that can be read, and IlFalse otherwise.

See also

isReadable(const IlString&).

doesExist(), isWritable(), isExecutable().

Tests if a path name has the read permission set for the current user.

Parameters

pathname

The path name to test. This must be in the system syntax.

Returns

IlTrue if the referenced path exists and has the read permission for the current user and IlFalse otherwise.

See also

isReadable().

doesExist(const IlString&), isWritable(const IlString&), isExecutable(const IlString&).

Returns IlTrue if the file system where this path name may be stored is case sensitive.

Returns

IlTrue if the file system is refers to an object that is executable, and IlFalse otherwise.

Tests if this object a sub-directory of another IlPathName.

Parameters

path	The path that is tested upon.

Returns

IlTrue if this object is a sub-directory of path, and IlFalse otherwise.

See also

isInCurrentDirectory().

Tests if this object is a physical directory.

Returns

IlTrue if this path is an actual, physical, directory, and IlFalse otherwise.

Tests if this path name refers to an object that can be written to.

Returns

IlTrue if the path name refers to an object that can be written, and IlFalse otherwise.

See also

isWritable(const IlString&).

doesExist(), isReadable(), isExecutable().

Tests if a path name has the write permission set for the current user.

Parameters

pathname

The path name to test. This must be in the system syntax.

Returns

IlTrue if the referenced path exists and has the write permission for the current user and IlFalse otherwise.

See also

isWritable().

doesExist(const IlString&), isReadable(const IlString&), isExecutable(const IlString&).

Tests if this object matches a path name filter.

This is useful only if the parameter is a filter (where the filename contains placeholders). Valid placeholders are star (‘’*') that matches with any string, and <i>question mark</i> ('?'`) that matches any character.

Note: The match succeeds only if the filter device part is identical to this object's.

Note: This function uses the Unix conventions:

• *.* means filename=* and extension=?*.
• * means filename=* and extension=*.

Here is a simple example of using a path name filter:

The filter can also contain one (and only one) alternate construct, using different patterns, separated by the '|' character (vertical bar, or pipe), between two parentheses. Here is an example of this:

Parameters

filter

The filter to match this path name against.

Returns

IlTrue if the current path matches filter, and IlFalse otherwise.

Appends a path name to this IlPathName.

This method is equivalent to operator+(const IlString& path).

• If path is an absolute path name, then it is copied into the current object.
• If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object. The string is copied and must be in the syntax of the system.

See also

operator+(const IlString&) const.

merge(const IlPathName&), merge(const IlString&).

Appends a path name to this IlPathName.

This method is equivalent to operator+(const IlPathName& path).

• If path is an absolute path name, then it is copied into the current object.
• If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object.

See also

operator+(const IlString&) const.

merge(const IlString&), merge(const char*).

Appends a path name to this IlPathName.

This method is equivalent to operator+(const IlString& path).

• If path is an absolute path name, then it is copied into the current object.
• If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object. The string must be in the syntax of the system.

See also

operator+(const IlString&) const.

merge(const IlPathName&), merge(const char*).

Opens a directory for reading.

This method opens a directory for reading. Successive calls to readDir() can list a directory content. The path name must be closed using the closeDir() method.

Example, on a Windows machine:

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

readDir(), closeDir(), rewindDir().

Returns the internal representation of the current object into a C-style string.

Warning

The returned string must not be deleted nor modified. The lifetime of the returned string is the same as the one of the IlPathName object.

Returns

An internal C pointer to the path name value.

Returns the whole path name in an IlString.

The path name is returned with the current system directory separator.

This method is equivalent to:

Returns

A string that reflects the object's content.

See also

operator const char*().

The not operator.

This operator tests whether this object is empty, that is all the parts of the path name are empty.

Returns

IlTrue if this object is empty, IlFalse otherwise.

See also

isEmpty().

The inequality operator.

This operator tests whether this object has a different value than another IlPathName.

Parameters

path	The object to compare this object to.

Returns

IlTrue if objects are not equal and IlFalse otherwise.

See also

operator==().

Join operator.

This operator appends a path name stored in path to the current object, exactly as it is done in the operator+(const IlPathName&) const operator.

Parameters

path	The path name to append to the current object. This string is copied by this operator.

Returns

The resulting IlPathName object.

See also

operator+(const IlPathName&) const, operator+(const IlString&) const.

operator+=(const char*).

merge(const char*).

Join operator.

This operator appends a IlPathName to the current object.

• If path is an absolute path name, then it is copied into the current object.
• If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Example, on a Windows machine:

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object.

See also

operator+(const IlString&) const, operator+(const char*) const.

operator+=(const IlPathName&).

merge(const IlPathName&).

Join operator.

This operator appends a path name stored in path to the current object, exactly as it is done in the operator+(const IlPathName&) const operator.

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object.

See also

operator+(const IlPathName&) const, operator+(const char*) const,

operator+=(const IlString&).

merge(const IlString&).

Appends a path name to this IlPathName.

If path is an absolute path name, then it is copied into the current object.
If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object. This must be in the system syntax. This string is copied internally.

Returns

The resulting IlPathName object.

See also

operator+=(const IlPathName&), operator+=(const IlString&).

merge(const char*).

Appends a path name to this IlPathName.

If path is an absolute path name, then it is copied into the current object.
If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object.

Returns

The resulting IlPathName object.

See also

operator+=(const IlString&), operator+=(const char*).

merge(const IlPathName&).

Appends a path name to this IlPathName.

If path is an absolute path name, then it is copied into the current object.
If path is a relative path name, then the file name and extension parts of the result will be filled with the respective values from path, and the directory part will be the result of a of join of the current directory value and the one in path.

Parameters

path	The path name to append to the current object. This must be in the system syntax.

Returns

The resulting IlPathName object.

See also

operator+=(const IlPathName&), operator+=(const char*).

merge(const IlString&).

Assignment operator.

Assigns pathname to this object.

Warning

pathname must be in the syntax of the system.

Parameters

pathname

The value that is assigned.

Returns

The current, modified object.

See also

operator=(const IlPathName&), operator=(const IlString&).

Assignment operator.

Copies pathname into the current object.

Parameters

pathname

The object that is copied.

Returns

The current, modified object.

See also

operator=(const IlString&), operator=(const char*).

Assignment operator.

Assigns pathname to this object.

Warning

pathname must be in the syntax of the system.

Parameters

pathname

The value that is assigned.

Returns

The current, modified object.

See also

operator=(const IlPathName&), operator=(const char*).

The equality operator.

This operator tests whether this object has the same value as another IlPathName.

Parameters

path	The object to compare this object to.

Returns

IlTrue if both objects are equal and IlFalse otherwise.

See also

operator!=().

Prepends a path name to this IlPathName.

• If the current path name an absolute path name, it it not modified.
• If the current path name is a relative path name, then the its directory part will be the result of a of join of the directory path of path and and the current one.

Parameters

path	The path name to prepend to the current object. This string is copied, and must be in the syntax of the system.

Returns

The resulting IlPathName object.

See also

merge(const char*).

prepend(const IlPathName&), prepend(const IlString&).

Prepends a path name to this IlPathName.

This method

• If the current path name an absolute path name, it it not modified.
• If the current path name is a relative path name, then the its directory part will be the result of a of join of the directory path of path and and the current one.

Parameters

path	The path name to prepend to the current object.

Returns

The resulting IlPathName object.

See also

merge(const IlPathName&).

prepend(const IlString&), prepend(const char*).

Prepends a path name to this IlPathName.

• If the current path name an absolute path name, it it not modified.
• If the current path name is a relative path name, then the its directory part will be the result of a of join of the directory path of path and and the current one.

Parameters

path	The path name to prepend to the current object. This must be in the syntax of the system.

Returns

The resulting IlPathName object.

See also

merge(const IlString&).

prepend(const IlPathName&), prepend(const char*).

Queries the last access time of the object referenced by this IlPathName.

Parameters

time	Is set to the last access time of the file system entity referenced by this path name object.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

queryChangedStatusTime(), queryModificationTime().

Queries the last time the object referenced by this IlPathName was renamed.

Note that on Windows system, this value corresponds to the creation time.

Parameters

time	Is set to the time when the file system entity referenced by this path name object was last renamed (or created, on Windows).

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

queryAccessTime(), queryModificationTime().

Queries the current directory.

This method copies the absolute path name of the current directory into currentDir.

Parameters

currentDir	The buffer where the path name of the current directory is stored.
size	The maximal number, including the final 0, of characters than currentDir can hold. If the path name of the current directory is longer than this size, the result is undefined.
drive	An optional parameter that indicates what drive to query the directory for. It is relevant on system that use devices (such as Windows). The default value, 0, indicates that you want to query the current directory on the current device.

See also

queryCurrentDirectory().

Queries the current directory.

This method assigns the absolute path name of the current directory into this path name object.

Parameters

drive

An optional parameter that indicates what drive to query the directory for. It is relevant on system that use devices (such as Windows). The default value, 0, indicates that you want to query the current directory on the current device.

See also

QueryCurrentDirectory().

changeCurrentDirectory().

Queries the permissions of the object referenced by this IlPathName.

The value depends on the system. If an error occurs, then the functions returns IlFalse; otherwise IlTrue.

Parameters

mode	Is set to the permission bits of the file system entity referenced by this path name object.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

changeMode().

Queries the time the object referenced by this IlPathName was last modified.

Parameters

time	Is set to the last modification time of the file system entity referenced by this path name object.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

queryAccessTime(), queryChangedStatusTime().

Reads the next entry of this IlPathName.

The current path name must have been opened using openDir() before this method is invoked.

Parameters

result

On exit, holds the path name that was read from this opened directory path name.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs. You should stop reading entries when this method returns IlFalse.

See also

openDir(), closeDir(), rewindDir().

Physically removes the file or directory corresponding to this IlPathName.

Parameters

recursive

If set to IlTrue and if this path name object represents a directory then the entire directory and all its content destroyed, including its sub-directories. The default value of IlFalse is used when the directory should be empty before removal.

Returns

IlTrue if the method succeeds and IlFalse if an error occurs.

See also

create().

Restart the reading of this directory path name all over.

After calling this function, the next value returned by readDir() will be the first entry of the directory. The current path name must have been opened using openDir() before this method is invoked.

See also

openDir(), readDir(), closeDir().

Sets the base name part of this IlPathName.

The base name is the concatenation of the filename and the extention parts.

Parameters

basename	The base name to set to the current object.
end	The index of the last character to use from basename. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from basename. The default value of 0 indicates the first character of the string.

See also

getBaseName().

Sets the device part of this IlPathName.

Parameters

device	The device to set to the current object.
end	The index of the last character to use from device. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from device. The default value of 0 indicates the first character of the string.

See also

getDevice().

Sets the directory part of this IlPathName.

Parameters

directory	The directory to set to the current object.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
type	The syntax (system, Unix or DOS) that the provided string is using. The default is SystemPathType.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

getDirectory().

setUnixDirectory(), setDosDirectory().

Sets the dirname part of this IlPathName.

The dirname of a path name is the concatenation of the path name device and directory parts.

Parameters

dirName	The device and directory to set to the current object.
end	The index of the last character to use from dirName. The default value of -1 indicates down to the end of the string.
type	The syntax (system, Unix or DOS) that the provided string is using. The default is SystemPathType.
start	The index of the first character to take from dirName. The default value of 0 indicates the first character of the string.

See also

getDirName().

setDevice(), setDirectory().

Sets the directory part of this IlPathName.

Parameters

directory	The directory to set to the current object. This must be in the DOS syntax.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

getDosDirectory().

setDirectory(), setUnixDirectory().

Sets the dirname part of this IlPathName.

The dirname of a path name is the concatenation of the path name device and directory parts.

Parameters

dirName	The device and directory to set to the current object. This must be in the DOS syntax.
end	The index of the last character to use from dirName. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from dirName. The default value of 0 indicates the first character of the string.

See also

setDirName(), setUnixDirName().

Sets the whole value of this IlPathName.

Parameters

value	The new value to set to the current object. This must be in the DOS syntax.
end	The index of the last character to use from value. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from value. The default value of 0 indicates the first character of the string.

See also

setValue().

setUnixValue().

Sets the extension part of this IlPathName.

Parameters

extension	The extension to set to the current object.
end	The index of the last character to use from extension. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from extension. The default value of 0 indicates the first character to use from extension.

See also

getExtension().

Sets the file name part of this IlPathName.

Parameters

filename	The filename to set to the current object.
end	The index of the last character to use from filename. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from filename. The default value of 0 indicates the first character to use from filename.

See also

getFileName().

Sets the directory part of this IlPathName.

Parameters

directory	The directory to set to the current object. This must be in the Unix syntax.
end	The index of the last character to use from directory. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from directory. The default value of 0 indicates the first character of the string.

See also

getUnixDirectory().

setDirectory(), setDosDirectory().

Sets the dirname part of this IlPathName.

The dirname of a path name is the concatenation of the path name device and directory parts.

Parameters

dirName	The device and directory to set to the current object. This must be in the Unix syntax.
end	The index of the last character to use from dirName. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from dirName. The default value of 0 indicates the first character of the string.

See also

setDirName(), setDosDirName().

Sets the whole value of this IlPathName.

Parameters

value	The new value to set to the current object. This must be in the Unix syntax.
end	The index of the last character to use from value. The default value of -1 indicates down to the end of the string.
start	The index of the first character to take from value. The default value of 0 indicates the first character of the string.

See also

setValue().

setDosValue().

Sets the whole value of this IlPathName.

Parameters

value	The new value to set to the current object.
end	The index of the last character to use from value. The default value of -1 indicates down to the end of the string.
type	The syntax (system, Unix or DOS) that the provided string is using. The default is SystemPathType.
start	The index of the first character to take from value. The default value of 0 indicates the first character of the string.

See also

getValue().