<?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="dict.serialize" module="max" category="Dictionary">
	<digest>
		Convert a dictionary's content to text
	</digest>
	<description>
		Use the <o>dict.serialize</o> object to output a serialized form of the contents of dictionary in text format. The text may be Dictionary Syntax, JSON, or Base64-compressed forms of these formats.
	</description>
	<!--METADATA-->
	<metadatalist>
		<metadata name="author">
			Cycling '74
		</metadata>
		<metadata name="tag">
			Dictionary
		</metadata>
	</metadatalist>
	<!--INLETS-->
	<inletlist>
		<inlet id="0" type="INLET_TYPE">
			<digest>
				dictionary whose contents will be serialized
			</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>
				serialized data from dictionary
			</digest>
			<description>
				TEXT_HERE
			</description>
		</outlet>
	</outletlist>
	<!--ARGUMENTS-->
	<objarglist />
	<!--MESSAGES-->
	<methodlist>
		<method name="dictionary">
			<arglist>
				<arg name="name" optional="0" type="symbol" />
			</arglist>
			<digest>
				Name of a dictionary whose content will be serialized
			</digest>
			<description>
				TEXT_HERE
			</description>
		</method>
	</methodlist>
	<!--ATTRIBUTES-->
	<attributelist>
		<attribute name="compress" get="1" set="1" type="int" size="1">
			<digest>
				Apply compression to the serialized dictionary
			</digest>
			<description>
				Apply compression to the serialized dictionary
			</description>
			<attributelist>
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Compress" />
				<attribute name="style" get="1" set="1" type="symbol" size="1" value="onoff" />
			</attributelist>
		</attribute>
		<attribute name="mode" get="1" set="1" type="symbol" size="1">
			<digest>
				Switch between dictionary syntax and JSON format
			</digest>
			<description>
				Switch between dictionary syntax and JSON format
			</description>
			<attributelist>
				<attribute name="category" get="1" set="1" type="symbol" size="1" value="Behavior" />
				<attribute name="label" get="1" set="1" type="symbol" size="1" value="Mode" />
			</attributelist>
		</attribute>
	</attributelist>
	<!--EXAMPLE-->
	<examplelist />
	<!--SEEALSO-->
	<seealsolist>
		<seealso name="dict.deserialize" />
		<seealso name="dict.group" />
		<seealso name="dict.iter" />
		<seealso name="dict.join" />
		<seealso name="dict.pack" />
		<seealso name="dict.print" />
		<seealso name="dict.route" />
		<seealso name="dict.slice" />
		<seealso name="dict.strip" />
		<seealso name="dict.unpack" />
		<seealso name="dict.view" />
		<seealso name="dict" />
		<seealso name="dictionaries" module="core" type="vignette" />
	</seealsolist>
	<discussion>
		<b>Note:</b> The colon (:) is a reserved character and is not supported in keys or values.
		<br />
		<br />
		Different formats of serialization may be accessed by changing attributes to this object. However, these attributes should be used carefully.
		<ul>
			<li>
				the mode attribute may choose between JSON and dictionary syntax
			</li>
			<li>
				the compress attribute will apply a compression algorithm
			</li>
		</ul>
		The non-default options all result in a single max symbol as output. This symbolization has the potential to bloat max's symbol table and thus degrade the overall performance of the max environment. Therefore it is recommended that you use the default (dictionary) mode with no compression.
	</discussion>
</c74object>
