[#BloombergLP-bdlb-String]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::String
:relfileprefix: ../../
:mrdocs:

Namespace for utility functions on STL‐style and C‐style strings.

== Synopsis

Declared in `<bdlb_string.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct String;
----

== Description

This `struct` provides a namespace for a suite of functions on STL‐style strings (`bsl::string`, `std::string`, `std::pmr::string`), C‐style strings, and strings specified by a `(const char *, int)` or `(char *, int)` pair.

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlb/String/areEqualCaseless-010.adoc[`areEqualCaseless`] 
| `areEqualCaseless` overloads
| xref:BloombergLP/bdlb/String/copy-01.adoc[`copy`] 
| Return a newly allocated null‐terminated copy of `string`.
| xref:BloombergLP/bdlb/String/lowerCaseCmp-0c.adoc[`lowerCaseCmp`] 
| Compare two strings using case‐insensitive ordering.
| xref:BloombergLP/bdlb/String/ltrim-03.adoc[`ltrim`] 
| `ltrim` overloads
| xref:BloombergLP/bdlb/String/pad-00.adoc[`pad`] 
| Pad `string` on the right with `padChar` up to `length`.
| xref:BloombergLP/bdlb/String/rtrim-07.adoc[`rtrim`] 
| `rtrim` overloads
| xref:BloombergLP/bdlb/String/skipLeadingTrailing.adoc[`skipLeadingTrailing`] 
| Advance `*begin` and regress `*end` past surrounding whitespace.
| xref:BloombergLP/bdlb/String/strnlen.adoc[`strnlen`] 
| Return the length of `string`, capped at `maximumLength`.
| xref:BloombergLP/bdlb/String/strrstr.adoc[`strrstr`] 
| Return the last occurrence of `subString` in `string`, or 0.
| xref:BloombergLP/bdlb/String/strrstrCaseless.adoc[`strrstrCaseless`] 
| Return the last case‐insensitive match of `subString`, or 0.
| xref:BloombergLP/bdlb/String/strstr.adoc[`strstr`] 
| Return the first occurrence of `subString` in `string`, or 0.
| xref:BloombergLP/bdlb/String/strstrCaseless.adoc[`strstrCaseless`] 
| Return the first case‐insensitive match of `subString`, or 0.
| xref:BloombergLP/bdlb/String/toFixedLength.adoc[`toFixedLength`] 
| Copy `srcString` into `dstString`, padding to `dstLength` if needed.
| xref:BloombergLP/bdlb/String/toLower-089.adoc[`toLower`] 
| Convert upper‐case characters in `string` to lower case.
| xref:BloombergLP/bdlb/String/toUpper-0f.adoc[`toUpper`] 
| Convert lower‐case characters in `string` to upper case.
| xref:BloombergLP/bdlb/String/trim-0bf.adoc[`trim`] 
| `trim` overloads
| xref:BloombergLP/bdlb/String/upperCaseCmp-036.adoc[`upperCaseCmp`] 
| Compare two strings as if both were converted to upper case.
|===



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