Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Char.IsSurrogate Method (String, Int32)

Indicates whether the character at the specified position in a specified string has a surrogate code point.

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

public static bool IsSurrogate (
	string s,
	int index
)
public static boolean IsSurrogate (
	String s, 
	int index
)
public static function IsSurrogate (
	s : String, 
	index : int
) : boolean
Not applicable.

Parameters

s

A string.

index

The character position in s.

Return Value

true if the character at position index in s is a either a high surrogate or a low surrogate; otherwise, false.

Exception typeCondition

ArgumentNullException

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

ArgumentOutOfRangeException

index is less than zero or greater than the last position in s.

Character positions in a string are indexed starting from zero.

A surrogate is a Char object with a Unicode code point in the range from U+D800 to U+DFFF. Each character with a code point in this range belongs to the UnicodeCategory.Surrogate category. The individual surrogate code point has no interpretation of its own, but only has meaning when used as part of a surrogate pair. For more information about surrogate pairs, see the Unicode Standard at the Unicode home page.

The following code example demonstrates IsSurrogate.

using System;

public class IsSurrogateSample {
	public static void Main() {
		string str = "\U00010F00"; // Unicode values between 0x10000 and 0x10FFF are represented by two 16-bit "surrogate" characters

		Console.WriteLine(Char.IsSurrogate('a'));		// Output: "False"
		Console.WriteLine(Char.IsSurrogate(str, 0));	// Output: "True"
	}
}

import System.*;

public class IsSurrogateSample
{
    public static void main(String[] args)
    {
        String str = "\u00010F00"; // Unicode values between 0x10000 and 
                                   // 0x10FFF are represented by two 16-bit
                                   // "surrogate" characters
        Console.WriteLine(Char.IsSurrogate('a'));       
        Console.WriteLine(Char.IsSurrogate(str, 0));    
    } //main
} //IsSurrogateSample

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft