[#BloombergLP-bdlat_SymbolicConverter-convert-0f]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat_SymbolicConverter.adoc[bdlat_SymbolicConverter]::convert
:relfileprefix: ../../
:mrdocs:

Convert the value of the specified `rhs` to the specified `lhs`.

== Synopsis

Declared in `<bdlat_symbolicconverter.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class LHS_TYPE,
    class RHS_TYPE>
static
int
convert(
    LHS_TYPE* lhs,
    RHS_TYPE const& rhs);
----

== Description

Optionally specify an `errorStream` to print error messages. Return 0 on success and a non‐zero value otherwise. The supported conversions are described in the `bdlat_symbolicconverter` component‐level documentation.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| destination object to receive the converted value
| *rhs*
| source object to convert from
|===


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