This documentation is archived and is not being maintained.

Char::IsSurrogate Method (String, Int32)

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

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

public:
static bool IsSurrogate(
	String^ s, 
	int index
)

Parameters

s
Type: System::String
A string.
index
Type: System::Int32
The position of the character to evaluate in s.

Return Value

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

ExceptionCondition
ArgumentNullException

s is nullptr.

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 UTF-16 code unit in the range from U+D800 to U+DFFF. Each character with a code unit in this range belongs to the UnicodeCategory::Surrogate category. The individual surrogate code unit has no interpretation of its own, but has meaning only 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 namespace System;
int main()
{

   // - escape params specifying Unicode not implemented in v7.0
   Console::WriteLine( Char::IsSurrogate( 'a' ) ); // Output: "False"
}



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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