Documentation

PATH

path.combine (path.join)

Combines an array of strings into a path.

Syntax

path.combine(path1, path2)
path.combine("C:", "Windows", "Explorer.exe")
path.currentdirectory (path.curdir)

Retrieves the current directory for the current process.

Syntax

path.currentdirectory
path.directory.name (path.dir.name)

Return the directory name from the path.

Syntax

path.directory.name('c:\windows\system32') // returns: system32
path.directory.box (path.dir.box)

Shows the directory selection box and returns the path of the specified directory.

Syntax

path.directory.box
path.empty

Check if one or more path is empty.

Syntax

path.empty(path)
path.empty(path1, path2, ...)
path.exists

Check if one or more path exists..

Syntax

path.exists(path)
path.exists(path1, path2, ...)
path.full

Returns the absolute path for the specified path string.

Syntax

path.full(path)
path.short

Retrieves the short path form of the specified path.

Syntax

path.short(path)
path.name

Return the name from the path.

Syntax

path.name(path)
path.location (path.parent)

Return the path of the parent

Syntax

path.location(path)
path.location.name

Return the name from the parent

Syntax

path.location.name(path)
path.root

Return the drive path

Syntax

path.root(path)
path.title

Return the title from the path

Syntax

path.title(path)
path.type

Return the type of path

Syntax

path.type(path) == type.file
path.file.name

Return the name of path

Syntax

path.file.name(path)
path.file.title

Return the name of path without extension

Syntax

path.file.title(path)
path.file.ext

Return the extension of path

Syntax

path.file.ext(path)
path.file.box

Shows the file selection box and returns the path of the specified file.

Syntax

path.file.box
path.file.box('All|*.*|Text|*.txt')
path.file.box('exe|*.exe', 'c:\windows')
path.file.box('exe|*.exe', 'c:\windows', 'explorer.exe')
path.isabsolute

Syntax

path.isabsolute(path)
path.isrelative

Syntax

path.isrelative(path)
path.isfile

Syntax

path.isfile(path)
path.isdirectory

Syntax

path.isdirectory(path)
path.isroot (path.isdrive)

Syntax

path.isdrive(path)
path.isclsid (path.isnamespace)

Syntax

path.isclsid(path)
path.isexe

Syntax

path.isexe(path)
path.removeextension

Remove the extension from the passed parameter.

Syntax

path.removeextension
path.lnktarget (path.lnk)

Return a path from the shortcut

Syntax

path.lnktarget
path.getknownfolder

Retrieves the full path of a known folder identified.

Syntax

path.getknownfolder('{905e63b6-c1bf-494e-b29c-65b732d3d21a}')
path.separator(path.sep)

Replacing the back slash with a forward slash or defining a spacer.

Syntax

path.separator('c:\windows\system32') return "c:/windows/system32"
path.separator('c:\windows\system32', '#') return "c:#windows#system32"

This page is open source. Noticed a typo? Or something unclear?
Improve this page on GitHub