Namespaces
Variants
Views
Actions

std::basic_string::find

From cppreference.com
< cpp‎ | string‎ | basic string
Revision as of 16:55, 26 August 2013 by P12 (Talk | contribs)

 
 
 
std::basic_string
 
size_type find( const basic_string& str, size_type pos = 0 ) const;
(1)
size_type find( const CharT* s, size_type pos, size_type count ) const;
(2)
size_type find( const CharT* s, size_type pos = 0 ) const;
(3)
size_type find( CharT ch, size_type pos = 0 ) const;
(4)

Finds the first substring equal to the given character sequence. Search begins at pos, i.e. the found substring must not begin in a position preceding pos.

1) Finds the first substring equal to str. If str.size() is zero, returns pos.
2) Finds the first substring equal to the first count characters of the character string pointed to by s. s can include null characters. If count is zero, returns pos.
3) Finds the first substring equal to the character string pointed to by s. The length of the string is determined by the first null character. If the length of s is zero, returns pos.
4) Finds the first character ch.

If pos >= size(), the function always returns npos.

Contents

Parameters

str - string to search for
pos - position at which to start the search
count - length of substring to search for
s - pointer to a character string to seach for
ch - character to search for

Return value

Position of the first character of the found substring or npos if no such substring is found.

Exceptions

1-4) (none)
(until C++11)
1,4)
noexcept specification:  
noexcept
  
2,3) (none)
(since C++11)
(until C++14)
1)
noexcept specification:  
noexcept
  
2,3,4) (none)
(since C++14)

Example

#include <string>
#include <iostream>
 
void print(std::string::size_type n, std::string const &s)
{
    if (n == std::string::npos) {
        std::cout << "not found\n";
    } else {
        std::cout << "found: " << s.substr(n) << '\n';
    }
}
 
int main()
{
    std::string::size_type n;
    std::string const s = "This is a string";
 
    // search from beginning of string
    n = s.find("is");
    print(n, s);
 
    // search from position 5
    n = s.find("is", 5);
    print(n, s);
 
    // find a single character
    n = s.find('a');
    print(n, s);
 
    // find a single character
    n = s.find('q');
    print(n, s);
}

Output:

found: is is a string
found: is a string
found: a string
not found

See also

finds the first occurrence of a substring of characters
(function) [edit]
finds the first occurrence of a wide string within another wide string
(function) [edit]
finds the first occurrence of a character
(function) [edit]
finds the first occurrence of a wide character in a wide string
(function) [edit]
find the last occurrence of a substring
(public member function) [edit]
find first occurrence of characters
(public member function) [edit]
find first absence of characters
(public member function) [edit]
find last occurrence of characters
(public member function) [edit]
find last absence of characters
(public member function) [edit]
searches for a range of elements
(function template) [edit]