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

Options for controlling the XML decoding process. The generated C++ code for this schema element is created by using bas_codegen.pl, run by balxml/code_from_xsd.pl with no hand‐editing.

== Synopsis

Declared in `<balxml_decoderoptions.h>`

[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.
| xref:BloombergLP/balxml/DecoderOptions/_04enum-04.adoc[`Unnamed enum`] 
| The number of attributes in this type.
| xref:BloombergLP/balxml/DecoderOptions/_04enum-0b.adoc[`Unnamed enum`] 
| Attribute indices used by `bdlat` attribute lookup for this type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/DecoderOptions/2constructor-06.adoc[`DecoderOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/DecoderOptions/2destructor.adoc[`~DecoderOptions`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/balxml/DecoderOptions/operator_assign-03.adoc[`operator=`] 
| 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‐modifiable) attribute of this object, supplying `accessor` with the corresponding attribute information structure until such invocation returns a non‐zero value. Return the value from the last invocation of `accessor` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/balxml/DecoderOptions/formattingMode.adoc[`formattingMode`] 
| Return the value of the "FormattingMode" attribute of this object.
| 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‐zero value. Return the value from the last invocation of `manipulator` (i.e., the invocation that terminated the sequence).
| xref:BloombergLP/balxml/DecoderOptions/maxDepth.adoc[`maxDepth`] 
| Return the value of the "MaxDepth" attribute of this object.
| 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`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of `level * spacesPerLevel`. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line. If `stream` is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.
| xref:BloombergLP/balxml/DecoderOptions/reset.adoc[`reset`] 
| Reset this object to the default value (i.e., its value upon default construction).
| xref:BloombergLP/balxml/DecoderOptions/setFormattingMode.adoc[`setFormattingMode`] 
| Set the "FormattingMode" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/DecoderOptions/setMaxDepth.adoc[`setMaxDepth`] 
| Set the "MaxDepth" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/DecoderOptions/setSkipUnknownElements.adoc[`setSkipUnknownElements`] 
| Set the "SkipUnknownElements" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/DecoderOptions/setValidateInputIsUtf8.adoc[`setValidateInputIsUtf8`] 
| Set the "ValidateInputIsUtf8" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/DecoderOptions/setValidateRootTag.adoc[`setValidateRootTag`] 
| Set the "ValidateRootTag" attribute of this object to the specified `value`.
| xref:BloombergLP/balxml/DecoderOptions/skipUnknownElements.adoc[`skipUnknownElements`] 
| Return the value of the "SkipUnknownElements" attribute of this object.
| xref:BloombergLP/balxml/DecoderOptions/validateInputIsUtf8.adoc[`validateInputIsUtf8`] 
| Return the value of the "ValidateInputIsUtf8" attribute of this object.
| xref:BloombergLP/balxml/DecoderOptions/validateRootTag.adoc[`validateRootTag`] 
| Return the value of the "ValidateRootTag" attribute of this object.
|===


== 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_INFO_ARRAY`] 
| Attribute metadata array for `bdlat` serialization of this type.
| xref:BloombergLP/balxml/DecoderOptions/CLASS_NAME.adoc[`CLASS_NAME`] 
| Name of this class for use in XML serialization.
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_FORMATTING_MODE.adoc[`DEFAULT_INITIALIZER_FORMATTING_MODE`] 
| Default initial value for `formattingMode` (0).
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_MAX_DEPTH.adoc[`DEFAULT_INITIALIZER_MAX_DEPTH`] 
| Default initial value for `maxDepth` (512).
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS.adoc[`DEFAULT_INITIALIZER_SKIP_UNKNOWN_ELEMENTS`] 
| Default initial value for `skipUnknownElements`.
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8.adoc[`DEFAULT_INITIALIZER_VALIDATE_INPUT_IS_UTF8`] 
| Default initial value for `validateInputIsUtf8`.
| xref:BloombergLP/balxml/DecoderOptions/DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG.adoc[`DEFAULT_INITIALIZER_VALIDATE_ROOT_TAG`] 
| Default initial value for `validateRootTag`.
|===


== Non-Member Functions

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


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