<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>

<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY. Rather, use the _ref.xml files found in the 'edits' folder.-->
<c74object name="filepath" module="max" category="Files">
	<digest>
		Manage and report on the Max search path
	</digest>
	<description>
		Provides access to the Max search path, and allows modification to the search path used by a patch.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Max
		</metadata>
		<metadata name="tag">
			Files
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				set Changes Path, append Adds Path
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
		<inlet id="1" type="INLET_TYPE">
			<digest>
			</digest>
			<description>
				TEXT_HERE
			</description>
		</inlet>
	</inletlist>
	<!--OUTLETS-->
	<outletlist>
		<outlet id="0" type="OUTLET_TYPE">
			<digest>
				Path Stored in Preferences
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist>
		<objarg name="path-type" optional="0" type="symbol">
			<digest>
				The search path to access
			</digest>
			<description>
				Specifies one of the Max search path types (<m>search</m>, <m>startup</m>, <m>help</m>, <m>action</m>, or <m>default</m>)
			</description>
		</objarg>
		<objarg name="preference" optional="1" type="int">
			<digest>
				The preference file file
			</digest>
			<description>
				A number greater than zero specifies a slot in the Preferences file. If the argument is <m>0</m> or no number is supplied, the path will not be saved in the Preferences file.
			</description>
			<discussion>
				You can use this feature to create temporary search paths for a patch. The action, help, and startup paths only have one slot. The search path can have up to 256 slots (normally there are about 8). The default path is never saved in the Preferences file.
			</discussion>
		</objarg>
	</objarglist>
	<!--MESSAGES-->
	<methodlist>
		<method name="bang">
			<arglist />
			<digest>
				Output the current path
			</digest>
			<description>
				<m>bang</m> causes the currently saved path name(s) to be output as a list.
			</description>
		</method>
		<method name="append">
			<arglist>
				<arg name="folder" optional="0" type="list" />
				<arg name="subfolder-flag" optional="1" type="int" />
			</arglist>
			<digest>
				Add a folder to a path
			</digest>
			<description>
				The word <m>append</m>, followed by a symbol which specifies a folder, adds the folder to the list of paths (but does not save it in the Preferences file). An optional integer subfolder flag will also add any subfolders when set to 1.
			</description>
		</method>
		<method name="clear">
			<arglist>
				<arg name="input" optional="0" type="int" />
			</arglist>
			<digest>
				Obsolete method
			</digest>
			<description>
				This method is obsolete. Currently, it has no effect.
			</description>
		</method>
		<method name="set">
			<arglist>
				<arg name="pathtype" optional="0" type="list" />
				<arg name="subfolder-flag" optional="1" type="int" />
			</arglist>
			<digest>
				Set the path to access
			</digest>
			<description>
				The word <m>set</m>, followed by the name of a Max search path type (<m>search</m>, <m>startup</m>, <m>help</m>, <m>action</m>, or <m>default</m>), sets the current search path to the type specified. An optional integer subfolder flag will also add any subfolders when set to 1.
			</description>
		</method>
		<method name="revert">
			<arglist />
			<digest>
				Revert to the saved path contents
			</digest>
			<description>
				Causes the pathnames to be reset to the last set of Max file preferences to be saved.
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<!--EXAMPLE-->
	<examplelist>
		<example img="filepath.png" caption="Use filepath to check your search path or temporarily set search path slots for a patch" />
	</examplelist>
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="conformpath" />
		<seealso name="filedate" />
		<seealso name="folder" />
		<seealso name="opendialog" />
	</seealsolist>
	<discussion>
		The <o>filepath</o> object is used in the File Preferences patcher to report and change the various folders Max uses to look for files at certain times. It can assist with managing search paths in the File Preferences patcher or manage paths specific to a single patch.
	</discussion>
	<misc name="Output">
		<entry name="symbol">
			<description>
				The currently stored path name in response to a <m>bang</m>.
			</description>
		</entry>
	</misc>
</c74object>
