Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of Boost. Click here to view this page for the latest version.
PrevUpHomeNext

Function replace_first_copy

boost::algorithm::replace_first_copy — Replace first algorithm.

Synopsis

// In header: <boost/algorithm/string/replace.hpp>


template<typename OutputIteratorT, typename Range1T, typename Range2T, 
         typename Range3T> 
  OutputIteratorT 
  replace_first_copy(OutputIteratorT Output, const Range1T & Input, 
                     const Range2T & Search, const Range3T & Format);
template<typename SequenceT, typename Range1T, typename Range2T> 
  SequenceT replace_first_copy(const SequenceT & Input, 
                               const Range1T & Search, 
                               const Range2T & Format);

Description

Replace the first match of the search substring in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.

[Note] Note

The second variant of this function provides the strong exception-safety guarantee

Parameters:

Output

An output iterator to which the result will be copied

Input

An input string

Search

A substring to be searched for

Format

A substitute string

Returns:

An output iterator pointing just after the last inserted character or a modified copy of the input


PrevUpHomeNext