[#BloombergLP-bdlat_EnumFunctions-fromString]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat_EnumFunctions.adoc[bdlat_EnumFunctions]::fromString
:relfileprefix: ../../
:mrdocs:

Load into the specified `result` the enumerator matching the specified `string` of the specified `stringLength`.

== Synopsis

Declared in `<bdlat_enumfunctions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
int
fromString(
    TYPE* result,
    char const* string,
    int stringLength);
----

== Description

Return 0 on success, and a non‐zero value with no effect on `result` if `string` and `stringLength` do not match any enumerator.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| enumeration object to receive the matching enumerator
| *string*
| string representation of the enumerator
| *stringLength*
| length of `string`
|===


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