Export (0) Print
Expand All

Char::GetUnicodeCategory Method (String, Int32)

Categorizes the character at the specified position in a specified string into a group identified by one of the UnicodeCategory values.

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

public:
static UnicodeCategory GetUnicodeCategory(
	String^ s, 
	int index
)

Parameters

s
Type: System::String

A String.

index
Type: System::Int32

The character position in s.

Return Value

Type: System.Globalization::UnicodeCategory
A UnicodeCategory enumerated constant that identifies the group that contains the character at position index in s.

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.

The Char::GetUnicodeCategory method does not always return the same UnicodeCategory value as the CharUnicodeInfo::GetUnicodeCategory(String, Int32) method when it is passed a particular character as a parameter. The CharUnicodeInfo::GetUnicodeCategory(String, Int32) method is designed to reflect the current version of the Unicode standard. In contrast, although the Char::GetUnicodeCategory method usually reflects the current version of the Unicode standard, it may return a character's category based on a previous version of the standard or it may return a category that differs from the current standard in order to preserve backward compatibility. As a result, we recommend that you use the CharUnicodeInfo::GetUnicodeCategory(Char) method instead of Char::GetUnicodeCategory(String, Int32).

The following example demonstrates GetUnicodeCategory.

using namespace System;
int main()
{
   char ch2 = '2';
   String^ str = "Upper Case";
   Console::WriteLine( Char::GetUnicodeCategory( 'a' ).ToString() ); // Output: S"LowercaseLetter"
   Console::WriteLine( Char::GetUnicodeCategory( ch2 ).ToString() ); // Output: S"DecimalDigitNumber"
   Console::WriteLine( Char::GetUnicodeCategory( str, 6 ).ToString() ); // Output: S"UppercaseLetter"
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft