.NET Framework Class Library
String.Contains Method

Note: This method is new in the .NET Framework version 2.0.

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)
C#
public bool Contains (
    string value
)
C++
public:
bool Contains (
    String^ value
)
J#
public boolean Contains (
    String value
)
JScript
public function Contains (
    value : String
) : boolean

Parameters

value

The String object to seek.

Return Value

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

Exception typeCondition

ArgumentNullException

value is a null reference (Nothing in Visual Basic).

Remarks

This method performs a word (case-sensitive and culture-sensitive) search using the current culture. The search begins at the first character position of this string and continues through the last character position.

Example

The following code 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
'
C#
// 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
*/
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
*/
J#
// 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 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

Version Information

.NET Framework

Supported in: 2.0
See Also

Tags :


Page view tracker