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

Parse the specified `input` using the specified `formattingMode`.

== Synopsis

Declared in `<balxml_typesparserutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
static
int
parse(
    TYPE* result,
    char const* input,
    int inputLength,
    int formattingMode);
----

== Description

Parse the specified `input` of the specified `inputLength` using the specified `formattingMode` and load the result into the specified `result`. Return 0 on success, and a non‐zero value otherwise. The behavior is undefined unless the parameterized `TYPE` and the `formattingMode` combination is supported (supported combinations are listed in the component‐level documentation).

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| parsed value
| *input*
| character buffer to parse
| *inputLength*
| number of characters in `input`
| *formattingMode*
| XML formatting mode to apply
|===


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