filetest

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

filetest [-L] [-b] [-c] [-d] [-e] [-f] [-g] [-h] [-k] [-l] [-p] [-r] [-s] [-u] [-w] [-x] [-z] string

filetest is NOT undoable, NOT queryable, and NOT editable.

The unary negation operator, "!", may precede the test.

Special Note:

If you test a file you own (the -r, -w, or -x tests), but the permission tested does not have the owner bit set, a non-zero (false) exit status will be returned even though the file may have the group or other bit set for that permission. The correct exit status will be set if you are super-user.

If more than one test is specified, only the first test is executed; the others are ignored.

Note:

• while filetest is similar to the "test" cmd from the unix shell, /sbin/test, it is not the same. Only a single test is allowed, not all options are supported, and the return code is reversed -- true returns 1 in filetest, but 0 in the shell.
• the filetest command works directly on raw system files and does not go through standard Maya file path resolution.

Return value

Flags

Long name (short name)	Argument types	Properties
-r(-r)
true if file exists and is readable.
-l(-l)
true if file exists and is a symbolic link.
-w(-w)
true if file exists and is writable.
-x(-x)
true if file exists and is executable.
-f(-f)
true if file exists and is a regular file.
-d(-d)
true if file exists and is a directory.
-h(-h)
true if file exists and is a symbolic link.
-c(-c)
true if file exists and is a character special file.
-b(-b)
true if file exists and is a block special file.
-p(-p)
true if file exists and is a named pipe (fifo).
-u(-u)
true if file exists and its set-user-ID bit is set.
-g(-g)
true if file exists and its set-group-ID bit is set.
-k(-k)
true if file exists and its sticky bit is set.
-s(-s)
true if file exists and has a size greater than zero.
-L(-L)
true if file exists and is a symbolic link.
-e(-e)
true if file (or directory) exists
-z(-z)
true if file is a Unix domain socket file (not supported on Windows)

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can be used more than once in a command.

MEL examples

// Test whether the temp directory exists
//
string $tmpDir = `internalVar -userTmpDir`;
filetest -d $tmpDir;
// Result: 1 //

// The following will fail because the temp dir is not a regular file
//
filetest -f $tmpDir;
// Result: 0 //