A newer version of Max is available. Click here to access the latest version of the Max documentation

folder Reference

List the files in a folder

folder

Description

Outputs all of the file names in a given folder. This can be especially useful for loading a umenu.

Discussion

The forward-slash character ( / ) is used as a path delineator. An initial slash at the beginning of a path indicates the boot volume. The Max application folder is referred to by using period-slash (e.g.: "./Cycling '74/max-help"), and the Cycling '74 folder may be referred to by using C74. A path on Macintosh systems is preceded by the name of the machine and a colon:
"Macintosh HD:/Users/Documents/max stuff/Desktop/phase_vocoder.pat"
On Windows systems, a path is preceded by a drive letter
"C:/Documents/max stuff/Desktop/phase_vocoder.pat"

Arguments

pathname [symbol]

Optional

The absolute path to a folder

Attributes

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

Gets the names of all files of a specific type within a specific folder, and outputs those names to be placed in a message object or a pop-up umenu object.

int

Arguments

input [int]
See the bang entry.

anything

Arguments

pathname [list]
See the symbol entry.

symbol

Arguments

pathname [symbol]
Specifies the pathname of a folder in the search path, and causes the contents of that folder to be output for storage in a umenu or a message. Input pathnames can contain slashes, colons, or backslashes as separators.

types

Arguments

typecode [list]
The word types, followed by one or more four-letter filetype codes sets the file types that the folder object will look for in the specified folder.

Output

append

Out left outlet: Immediately following the clear message, each filename in the specified folder is sent out in alphabetical order preceded by the word append.

clear

Out left outlet: When a pathname or a bang is received in the inlet, the first message that is sent out the left outlet is clear, which is intended to erase the contents of a receiving message or umenu object.

int

Out right outlet: When a pathname or a bang is received in the inlet, the number of items in the folder is sent out the right outlet.

See Also

Name Description
conformpath Convert file paths styles
dropfile Drag and drop files
filein Read and access a file of binary data
filepath Manage and report on the Max search path
opendialog Open a dialog to ask for a file or folder
pcontrol Open and close subwindows
umenu Pop-up menu