[#BloombergLP-bdlde-Utf8Util-isValidCodePoint]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::xref:BloombergLP/bdlde/Utf8Util.adoc[Utf8Util]::isValidCodePoint
:relfileprefix: ../../../
:mrdocs:

Return whether `codePoint` begins a valid UTF‐8 code point.

== Synopsis

Declared in `<bdlde_utf8util.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
bool
isValidCodePoint(
    int* status,
    char const* codePoint,
    xref:BloombergLP/bdlde/Utf8Util/size_type.adoc[size_type] numBytes);
----

== Description

If the specified `codePoint` (having at least the specified `numBytes`) refers to a valid UTF‐8 code point then return `true` and load the specified `status` with the number of bytes in the code‐point; otherwise, if `codePoint` is not a valid code‐point, return `false` and load `status` with one of the (negative) `ErrorStatus` constants. The behavior is undefined unless `numBytes > 0`.

== Return Value

`true` if `codePoint` is valid UTF‐8, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *status*
| receives byte length on success, or an `ErrorStatus` value
| *codePoint*
| candidate first byte of a UTF‐8 code point
| *numBytes*
| number of bytes available at `codePoint`
|===


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