[#BloombergLP-balxml-DecoderOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::DecoderOptions
:relfileprefix: ../../
:mrdocs:

Options for controlling the XML decoding process&period; The generated C&plus;&plus; code for this schema element is created by using bas&lowbar;codegen&period;pl, run by balxml&sol;code&lowbar;from&lowbar;xsd&period;pl with no hand&hyphen;editing&period;

== Synopsis

Declared in `&lt;balxml&lowbar;decoderoptions&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DecoderOptions;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/DecoderOptions/_04enum-0e.adoc[`Unnamed enum`] 
| Attribute ids used by `bdlat` attribute lookup for this type&period;
| xref:BloombergLP/balxml/DecoderOptions/_04enum-04.adoc[`Unnamed enum`] 
| The number of attributes in this type&period;
| xref:BloombergLP/balxml/DecoderOptions/_04enum-0b.adoc[`Unnamed enum`] 
| Attribute indices used by `bdlat` attribute lookup for this type&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/DecoderOptions/2constructor-06.adoc[`DecoderOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/DecoderOptions/2destructor.adoc[`&#126;DecoderOptions`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/balxml/DecoderOptions/operator_assign-03.adoc[`operator&equals;`] 
| Assignment operators
| xref:BloombergLP/balxml/DecoderOptions/accessAttribute-08.adoc[`accessAttribute`] 
| `accessAttribute` overloads
| xref:BloombergLP/balxml/DecoderOptions/accessAttributes.adoc[`accessAttributes`] 
| Invoke the specified `accessor` sequentially on each (non&hyphen;modifiable) attribute of this object, supplying `accessor` with the corresponding attribute information structure until such invocation returns a non&hyphen;zero value&period; Return the value from the last invocation of `accessor` (i&period;e&period;, the invocation that terminated the sequence)&period;
| xref:BloombergLP/balxml/DecoderOptions/formattingMode.adoc[`formattingMode`] 
| Return the value of the &quot;FormattingMode&quot; attribute of this object&period;
| xref:BloombergLP/balxml/DecoderOptions/manipulateAttribute-08.adoc[`manipulateAttribute`] 
| `manipulateAttribute` overloads
| xref:BloombergLP/balxml/DecoderOptions/manipulateAttributes.adoc[`manipulateAttributes`] 
| Invoke the specified `manipulator` sequentially on the address of each (modifiable) attribute of this object, supplying `manipulator` with the corresponding attribute information structure until such invocation returns a non&hyphen;zero value&period; Return the value from the last invocation of `manipulator` (i&period;e&period;, the invocation that terminated the sequence)&period;
| xref:BloombergLP/balxml/DecoderOptions/maxDepth.adoc[`maxDepth`] 
| Return the value of the &quot;MaxDepth&quot; attribute of this object&period;
| xref:BloombergLP/balxml/DecoderOptions/print.adoc[`print`] 
| Format this object to the specified output `stream` at the optionally specified indentation `level` and return a reference to the modifiable `stream`&period; If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects&period; Each line is indented by the absolute value of `level &ast; spacesPerLevel`&period; If `level` is negative, suppress indentation of the first line&period; If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line&period; If `stream` is initially invalid, this operation has no effect&period; Note that a trailing newline is provided in multiline mode only&period;
| xref:BloombergLP/balxml/DecoderOptions/reset.adoc[`reset`] 
| Reset this object to the default value (i&period;e&period;, its value upon default construction)&period;
| xref:BloombergLP/balxml/DecoderOptions/setFormattingMode.adoc[`setFormattingMode`] 
| Set the &quot;FormattingMode&quot; attribute of this object to the specified `value`&period;
| xref:BloombergLP/balxml/DecoderOptions/setMaxDepth.adoc[`setMaxDepth`] 
| Set the &quot;MaxDepth&quot; attribute of this object to the specified `value`&period;
| xref:BloombergLP/balxml/DecoderOptions/setSkipUnknownElements.adoc[`setSkipUnknownElements`] 
| Set the &quot;SkipUnknownElements&quot; attribute of this object to the specified `value`&period;
| xref:BloombergLP/balxml/DecoderOptions/setValidateInputIsUtf8.adoc[`setValidateInputIsUtf8`] 
| Set the &quot;ValidateInputIsUtf8&quot; attribute of this object to the specified `value`&period;
| xref:BloombergLP/balxml/DecoderOptions/setValidateRootTag.adoc[`setValidateRootTag`] 
| Set the &quot;ValidateRootTag&quot; attribute of this object to the specified `value`&period;
| xref:BloombergLP/balxml/DecoderOptions/skipUnknownElements.adoc[`skipUnknownElements`] 
| Return the value of the &quot;SkipUnknownElements&quot; attribute of this object&period;
| xref:BloombergLP/balxml/DecoderOptions/validateInputIsUtf8.adoc[`validateInputIsUtf8`] 
| Return the value of the &quot;ValidateInputIsUtf8&quot; attribute of this object&period;
| xref:BloombergLP/balxml/DecoderOptions/validateRootTag.adoc[`validateRootTag`] 
| Return the value of the &quot;ValidateRootTag&quot; attribute of this object&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/DecoderOptions/lookupAttributeInfo-0b.adoc[`lookupAttributeInfo`] 
| `lookupAttributeInfo` overloads
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/DecoderOptions/ATTRIBUTE_INFO_ARRAY.adoc[`ATTRIBUTE&lowbar;INFO&lowbar;ARRAY`] 
| Attribute metadata array for `bdlat` serialization of this type&period;
| xref:BloombergLP/balxml/DecoderOptions/CLASS_NAME.adoc[`CLASS&lowbar;NAME`] 
| Name of this class for use in XML serialization&period;
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_FORMATTING_MODE.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;FORMATTING&lowbar;MODE`] 
| Default initial value for `formattingMode` (0)&period;
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_MAX_DEPTH.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;MAX&lowbar;DEPTH`] 
| Default initial value for `maxDepth` (512)&period;
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;SKIP&lowbar;UNKNOWN&lowbar;ELEMENTS`] 
| Default initial value for `skipUnknownElements`&period;
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;VALIDATE&lowbar;INPUT&lowbar;IS&lowbar;UTF8`] 
| Default initial value for `validateInputIsUtf8`&period;
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG.adoc[`DEFAULT&lowbar;INITIALIZER&lowbar;VALIDATE&lowbar;ROOT&lowbar;TAG`] 
| Default initial value for `validateRootTag`&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/operator_not_eq-0c.adoc[`operator!&equals;`]
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise&period; Two attribute objects do not have the same value if one or more respective attributes differ in values&period;
| xref:BloombergLP/balxml/operator_eq-0f.adoc[`operator&equals;&equals;`]
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise&period; Two attribute objects have the same value if each respective attribute has the same value&period;
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
