Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::StringCopy()

ot::StringCopy() function

Copies a string into a given target buffer with a given size if it fits.

Syntax

Show:

Summary

Declaration

Definition

from string.hpp:182

Error StringCopy(char *TargetBuffer, uint16_t aTargetSize, const char *aSource, StringEncodingCheck aEncodingCheck);

Implemented in string.cpp:171

Arguments

Argument

Description

TargetBuffer

aTargetSize

The size (number of characters) in @p aTargetBuffer array.

aSource

A pointer to null-terminated string to copy from. Can be `nullptr` which treated as "".

aEncodingCheck

Specifies the encoding format check (e.g., UTF-8) to perform.

Return value

kErrorNone The @p aSource fits in the given buffer. @p aTargetBuffer is updated. kErrorInvalidArgs The @p aSource does not fit in the given buffer. kErrorParse The @p aSource does not follow the encoding format specified by @p aEncodingCheck.

References

Code

Location

Error StringCopy(char *aTargetBuffer, uint16_t aTargetSize, const char *aSource, StringEncodingCheck aEncodingCheck)

string.cpp:171

Error StringCopy(char (&aTargetBuffer)[kSize],

string.hpp:198

Error StringCopy(char *TargetBuffer, uint16_t aTargetSize, const char *aSource, StringEncodingCheck aEncodingCheck);

string.hpp:182

Call Tree

ot::StringCopy() calls 2 functions:

ot::StringCopy()

ot::StringLength()

ot::IsValidUtf8String()

Data Use

ot::StringCopy() reads 6 variables:

ot::StringEncodingCheck::kStringNoEncodingCheck

ot::StringEncodingCheck::kStringCheckUtf8Encoding

ot::kNullChar

ot::kErrorNone

ot::kErrorParse

ot::kErrorInvalidArgs

ot::StringCopy()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out