Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
string::copy

Copy a substring to another string.

Synopsis
std::size_t
copy(
    char* dest,
    std::size_t count,
    std::size_t pos = 0) const;
Description

Copies std::min(count, size() - pos) characters starting at index pos to the string pointed to by dest.

Remarks

The resulting string is not null terminated.

Return Value

The number of characters copied.

Parameters

Name

Description

count

The number of characters to copy.

dest

The string to copy to.

pos

The index to begin copying from. The default argument for this parameter is 0.

Exceptions

Type

Thrown On

std::out_of_range

pos > max_size()


PrevUpHomeNext