String.Contains Method (System)

Contains Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

String..::.Contains Method

Returns a value indicating whether the specified String object occurs within this string.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

Public Function Contains ( _
    value As String _
) As Boolean

Visual Basic (Usage)

Dim instance As String
Dim value As String
Dim returnValue As Boolean

returnValue = instance.Contains(value)

public bool Contains(
    string value
)

Visual C++

public:
bool Contains(
    String^ value
)

JScript

public function Contains(
    value : String
) : boolean

Parameters

value: Type: System..::.String
The String object to seek.

Return Value

Type: System..::.Boolean
true if the value parameter occurs within this string, or if value is the empty string (""); otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	value is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

This method performs an ordinal (case-sensitive and culture-insensitive) comparison. The search begins at the first character position of this string and continues through the last character position.

Examples

The following example determines whether the string "fox" is a substring of a familiar quotation.

Visual Basic

' This example demonstrates the String.Contains() method
Imports System

Class Sample
   Public Shared Sub Main()
      Dim s1 As String = "The quick brown fox jumps over the lazy dog"
      Dim s2 As String = "fox"
      Dim b As Boolean
      b = s1.Contains(s2)
      Console.WriteLine("Is the string, s2, in the string, s1?: {0}", b)
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'
'Is the string, s2, in the string, s1?: True
'

// This example demonstrates the String.Contains() method
using System;

class Sample 
{
    public static void Main() 
    {
    string s1 = "The quick brown fox jumps over the lazy dog";
    string s2 = "fox";
    bool b;
    b = s1.Contains(s2);
    Console.WriteLine("Is the string, s2, in the string, s1?: {0}", b);
    }
}
/*
This example produces the following results:

Is the string, s2, in the string, s1?: True
*/

Visual C++

// This example demonstrates the String.Contains() method
using namespace System;
int main()
{
   String^ s1 = "The quick brown fox jumps over the lazy dog";
   String^ s2 = "fox";
   bool b;
   b = s1->Contains( s2 );
   Console::WriteLine( "Is the string, s2, in the string, s1?: {0}", b );
}

/*
This example produces the following results:

Is the string, s2, in the string, s1?: True
*/

// This example demonstrates the String.Contains() method
import System.*;

class Sample
{
    public static void main(String[] args)
    {
        String s1 = "The quick brown fox jumps over the lazy dog";
        String s2 = "fox";
        boolean b;
        b = s1.Contains(s2);
        Console.WriteLine("Is the string, s2, in the string, s1?: {0}", 
            (System.Boolean)b);
    } //main
} //Sample
/*
This example produces the following results:

Is the string, s2, in the string, s1?: True
*/

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information