[#BloombergLP-balb-CustomString]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::CustomString
:relfileprefix: ../../
:mrdocs:

This class provides a customized string type used by test messages&period;

== Synopsis

Declared in `&lt;balb&lowbar;testmessages&period;h&gt;`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomString/BaseType.adoc[`BaseType`] 
| Base string type for this customized type&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomString/2constructor-0d.adoc[`CustomString`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balb/CustomString/2destructor.adoc[`&#126;CustomString`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/balb/CustomString/operator_assign.adoc[`operator&equals;`] 
| Assign to this object the value of the specified `rhs` object&period;
| xref:BloombergLP/balb/CustomString/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to this object the value read from the specified input `stream` using the specified `version` format and return a reference to the modifiable `stream`&period;
| xref:BloombergLP/balb/CustomString/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write the value of this object to the specified output `stream` using the specified `version` format and return a reference to the modifiable `stream`&period;
| xref:BloombergLP/balb/CustomString/fromString.adoc[`fromString`] 
| Convert from the specified `value` to this type&period; Return 0 if successful and non&hyphen;zero otherwise&period;
| xref:BloombergLP/balb/CustomString/maxSupportedBdexVersion.adoc[`maxSupportedBdexVersion`] 
| Return the most current `bdex` streaming version number supported by this class&period;
| xref:BloombergLP/balb/CustomString/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;
| xref:BloombergLP/balb/CustomString/reset.adoc[`reset`] 
| Reset this object to the default value (i&period;e&period;, its value upon default construction)&period;
| xref:BloombergLP/balb/CustomString/toString.adoc[`toString`] 
| Convert this value to `bsl&colon;&colon;string`&period;
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomString/checkRestrictions.adoc[`checkRestrictions`] 
| Check if the specified `value` satisfies the restrictions of this class (i&period;e&period;, &quot;CustomString&quot;)&period;
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomString/CLASS_NAME.adoc[`CLASS&lowbar;NAME`] 
| Name of this class&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balb/operator_not_eq-06a.adoc[BloombergLP::balb::operator!&equals;]`
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise&period;
| `xref:BloombergLP/balb/operator_eq-055.adoc[BloombergLP::balb::operator&equals;&equals;]`
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise&period;
|===


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