String Constructor

String constructors fall into two categories: those without pointer parameters, and those with pointer parameters. The constructors that use pointers are not CLS-compliant. In addition, Visual Basic does not support the use of pointers, and C# requires code that uses pointers to run in an unsafe context. For more information, see unsafe (C# Reference).

For additional guidance on choosing an overload, see Which method do I call?

String(Char[] value)

Initializes the new instance to the value indicated by an array of Unicode characters. This constructor copies Unicode characters(example).

String(Char[] value, Int32 startIndex, Int32 length)

Initializes the new instance to the value indicated by an array of Unicode characters, a starting character position within that array, and a length (example).

String(Char c, Int32 count)

Initializes the new instance to the value indicated by a specified Unicode character repeated a specified number of times (example).

String(char* value)

(Not CLS-compliant) Initializes the new instance to the value indicated by a pointer to an array of Unicode characters that is terminated by a null character (U+0000 or '\0'). (example).

Permission: SecurityCriticalAttribute, requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

String(char* value, Int32 startIndex, Int32 length)

(Not CLS-compliant) Initializes the new instance to the value indicated by a pointer to an array of Unicode characters, a starting character position within that array, and a length. The constructor copies the Unicode characters from value starting at index startIndex and ending at index startIndex + length – 1 (example).

Permission: SecurityCriticalAttribute, requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

String(SByte* value)

(Not CLS-compliant) Initializes the new instance to the value indicated by a pointer to an array of 8-bit signed integers. The array is assumed to represent a string encoded using the current system code page (that is, the encoding specified by Encoding::Default). The constructor processes characters from value starting from the location specified by the pointer until a null character (0x00) is reached (example).

Permission: SecurityCriticalAttribute, requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

String(SByte* value, Int32 startIndex, Int32 length)

(Not CLS-compliant) Initializes the new instance to the value indicated by a pointer to an array of 8-bit signed integers, a starting position within that array, and a length. The array is assumed to represent a string encoded using the current system code page (that is, the encoding specified by Encoding::Default). The constructor processes characters from value starting at startIndex and ending at startIndex + length – 1 (example).

Permission: SecurityCriticalAttribute, requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

String(SByte* value, Int32 startIndex, Int32 length, Encoding enc)

(Not CLS-compliant) Initializes the new instance to the value indicated by a pointer to an array of 8-bit signed integers, a starting position within that array, a length, and an Encoding object.

Permission: SecurityCriticalAttribute, requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

Here is a complete list of parameters used by Stringconstructors that do not include a pointer parameter. For the parameters used by each overload, see the overload syntax above.

Here is a complete list of parameters used by Stringconstructors that include a pointer parameter. For the parameters used by each overload, see the overload syntax above.

Here's a list of exceptions thrown by constructors that do not include pointer parameters.

Here's a list of exceptions thrown by constructors that include pointer parameters.

The most commonly used technique for creating strings programmatically is simple assignment, as illustrated in this example. The String class also includes four types of constructor overloads that let you create strings from the following values:

• From a character array (an array of UTF-16-encoded characters). You can create a new String object from the characters in the entire array or a portion of it. The String(array<Char>^) constructor copies all the characters in the array to the new string. The String(array<Char>^, Int32, Int32) constructor copies the characters from index startIndex to index startIndex + length – 1 to the new string. If length is zero, the value of the new string is String::Empty.

  If your code repeatedly instantiates strings that have the same value, you can improve application performance by using an alternate means of creating strings. For more information, see Handling repetitive strings.

• From a single character that is duplicated zero, one, or more times, by using the String(Char, Int32) constructor. If count is zero, the value of the new string is String::Empty.

• From a pointer to a null-terminated character array, by using the String(Char*) or String(Char*, Int32, Int32) constructor. Either the entire array or a specified range can be used to initialize the string. The constructor copies a sequence of Unicode characters starting from the specified pointer or from the specified pointer plus startIndex and continuing to the end of the array or for length characters. If value is a null pointer or length is zero, the constructor creates a string whose value is String::Empty. If the copy operation proceeds to the end of the array and the array is not null-terminated, the constructor behavior is system-dependent. Such a condition might cause an access violation.

  If the array contains any embedded null characters (U+0000 or '\0') and the String(Char*, Int32, Int32) overload is called, the string instance contains length characters including any embedded nulls. The following example shows what happens when a pointer to an array of 10 elements that includes two null characters is passed to the String(Char*, Int32, Int32) method. Because the address is the beginning of the array and all elements in the array are to be added to the string, the constructor instantiates a string with ten characters, including two embedded nulls. On the other hand, if the same array is passed to the String(Char*) constructor, the result is a four-character string that does not include the first null character.

  C#

  C++

  Copy

  using namespace System;
  
  void main()
  {
     wchar_t chars[] = { L'a', L'b', L'c', L'd', L'\0', L'A', L'B', 
                         L'C', L'D', L'\0' };
     Char* chPtr = chars;
     String^ s = gcnew String(chPtr, 0, 
                              sizeof(chars) / sizeof (wchar_t));            
     for each (Char ch in s)
        Console::Write("{0:X4} ", Convert::ToUInt16(ch));
     Console::WriteLine();
  
     s = gcnew String(chPtr);         
  
     for each (Char ch in s)
        Console::Write("{0:X4} ", Convert::ToUInt16(ch));
     Console::WriteLine();    
  }
  // The example displays the following output:
  //       0061 0062 0063 0064 0000 0041 0042 0043 0044 0000
  //       0061 0062 0063 0064
  

  The array must contain Unicode characters. In C++, this means that the character array must be defined either as the managed Char[] type or the unmanagedwchar_t[] type.

  If the String(Char*) overload is called and the array is not null-terminated, or if the String(Char*, Int32, Int32) overload is called and startIndex + length-1 includes a range that it outside the memory allocated for the sequence of characters, the behavior of the constructor is system-dependent, and an access violation may occur. In addition, on the Intel Itanium processor, calls to theString(Char*, Int32, Int32)constructor may throw a DataMisalignedException exception. If this occurs, call the String(array<Char>^, Int32, Int32) instead.

• From a pointer to a signed byte array. Either the entire array or a specified range can be used to initialize the string. The sequence of bytes can be interpreted by using the default code page encoding, or an encoding can be specified in the constructor call. If the constructor tries to instantiate a string from an entire array that is not null-terminated, or if the range of the array from value + startIndex to value + startIndex + length -1 is outside of the memory allocated for the array, the behavior of this constructor is system-dependent, and an access violation may occur.

  The three constructors that include a signed byte array as a parameter are designed primarily to convert a C++ char array to a string, as shown in this example:

  C++

  Copy

  using namespace System;
  
  void main()
  {
        char chars[] = { 'a', 'b', 'c', 'd', '\x00' };
  
        char* charPtr = chars;
        String^ value = gcnew String(charPtr);
  
        Console::WriteLine(value);
  }
  // The example displays the following output:
  //      abcd
  

  If the array contains any null characters ('\0') or bytes whose value is 0 and the String(SByte*, Int32, Int32) overload is called, the string instance contains length characters including any embedded nulls. The following example shows what happens when a pointer to an array of 10 elements that includes two null characters is passed to the String(SByte*, Int32, Int32) method. Because the address is the beginning of the array and all elements in the array are to be added to the string, the constructor instantiates a string with ten characters, including two embedded nulls. On the other hand, if the same array is passed to the String(SByte*) constructor, the result is a four-character string that does not include the first null character.

  C#

  C++

  Copy

  using namespace System;
  
  void main()
  {
     char bytes[] = { 0x61, 0x62, 0x063, 0x064, 0x00, 0x41, 0x42,0x43, 
                      0x44, 0x00 };
  
     char* bytePtr = bytes;
     String^ s = gcnew String(bytePtr, 0, sizeof(bytes) / sizeof (char));
  
     for each (Char ch in s)
        Console::Write("{0:X4} ", Convert::ToUInt16(ch));
  
     Console::WriteLine();
  
     s = gcnew String(bytePtr);
  
     for each (Char ch in s)
        Console::Write("{0:X4} ", Convert::ToUInt16(ch));
     Console::WriteLine();       
  }
  // The example displays the following output:
  //      0061 0062 0063 0064 0000 0041 0042 0043 0044 0000
  //      0061 0062 0063 0064
  

  Because the String(SByte*) and String(SByte*, Int32, Int32) constructors interpret value by using the default ANSI code page, calling these constructors with identical byte arrays may create strings that have different values on different systems.

Apps that parse or decode streams of text often use the String(array<Char>^, Int32, Int32) constructor or the StringBuilder::Append(array<Char>^, Int32, Int32) method to convert sequences of characters into a string. Repeatedly creating new strings with the same value instead of creating and reusing one string wastes memory. If you are likely to create the same string value repeatedly by calling the String(array<Char>^, Int32, Int32) constructor, even if you do not know in advance what those identical string values may be, you can use a lookup table instead.

For example, suppose you read and parse a stream of characters from a file that contains XML tags and attributes. When you parse the stream, you repeatedly encounter certain tokens (that is, sequences of characters that have a symbolic meaning). Tokens equivalent to the strings "0", "1", "true", and "false" are likely to occur frequently in an XML stream.

Instead of converting each token into a new string, you can create a System.Xml::NameTable object to hold commonly occurring strings. The NameTable object improves performance, because it retrieves stored strings without allocating temporary memory. When you encounter a token, use the NameTable::Get(array<Char>^, Int32, Int32) method to retrieve the token from the table. If the token exists, the method returns the corresponding string. If the token does not exist, use the NameTable::Add(array<Char>^, Int32, Int32) method to insert the token into the table and to get the corresponding string.

The following example creates a new string by assigning it a string literal. It creates a second string by assigning the value of the first string to it. These are the two most common ways to instantiate a new String object.

using namespace System;

void main()
{
   String^ value1 = L"This is a string.";
   String^ value2 = value1;
   Console::WriteLine(value1);
   Console::WriteLine(value2);
}
// The example displays the following output:
//    This is a string.
//    This is a string.

The following example demonstrates how to create a new String object from a character array.

// Unicode Mathematical operators
wchar_t charArray1[4] = {L'\x2200',L'\x2202',L'\x200F',L'\x2205'};
wchar_t * lptstr1 =  &charArray1[ 0 ];
String^ wszMathSymbols = gcnew String( lptstr1 );

// Unicode Letterlike Symbols
wchar_t charArray2[4] = {L'\x2111',L'\x2118',L'\x2122',L'\x2126'};
wchar_t * lptstr2 =  &charArray2[ 0 ];
String^ wszLetterLike = gcnew String( lptstr2 );

// Compare Strings - the result is false
Console::WriteLine( String::Concat( L"The Strings are equal? ", (0 == String::Compare( wszLetterLike, wszMathSymbols ) ? (String^)"TRUE" : "FALSE") ) );

The following example demonstrates how to create a new String object from a portion of a character array, and how to create a new String object that contains multiple occurrences of a single character.

// Create a Unicode String with 5 Greek Alpha characters
String^ szGreekAlpha = gcnew String( L'\x0391',5 );

// Create a Unicode String with a Greek Omega character
wchar_t charArray5[3] = {L'\x03A9',L'\x03A9',L'\x03A9'};
String^ szGreekOmega = gcnew String( charArray5,2,1 );
String^ szGreekLetters = String::Concat( szGreekOmega, szGreekAlpha, szGreekOmega->Clone() );

// Examine the result
Console::WriteLine( szGreekLetters );

// The first index of Alpha
int ialpha = szGreekLetters->IndexOf( L'\x0391' );

// The last index of Omega
int iomega = szGreekLetters->LastIndexOf( L'\x03A9' );
Console::WriteLine( String::Concat(  "The Greek letter Alpha first appears at index ", Convert::ToString( ialpha ) ) );
Console::WriteLine( String::Concat(  " and Omega last appears at index ", Convert::ToString( iomega ),  " in this String." ) );

The following example demonstrates how to create a new String object from a pointer to an array of characters. The C# example must be compiled by using the /unsafe compiler switch.

using namespace System;

void main()
{
   wchar_t characters[] = {L'H',L'e',L'l',L'l',L'o',L' ', 
                           L'W',L'o',L'r',L'l',L'd',L'!',L'\x0000'};

   Char* charPtr = characters;
   String^ value = gcnew String(charPtr);
   Console::WriteLine(value);
}
// The example displays the following output:
//        Hello world!

The following example examines the elements of a character array for either a period or an exclamation point. If one is found, it instantiates a string from the characters in the array that precede the punctuation symbol. If not, it instantiates a string with the entire contents of the array. The C# example must be compiled using the /unsafe compiler switch.

using namespace System;


void main()
{
   wchar_t characters[] = {L'H',L'e',L'l',L'l',L'o',L' ', 
                           L'W',L'o',L'r',L'l',L'd',L'!',L'\x0000'};

   Char* charPtr = characters;
   int length = 0;
   Char* iterator = charPtr;

   while (*iterator != '\x0000')
   {
      if (*iterator == L'!' || *iterator == L'.')
         break;
      *iterator++;
      length++;
   }
   String^ value = gcnew String(charPtr, 0, length);
   Console::WriteLine(value);
}
// The example displays the following output:
//      Hello World

The following example demonstrates how you can create an instance of the String class with the String(SByte*) constructor.

// Null terminated ASCII characters in a simple char array
char charArray3[4] = {0x41,0x42,0x43,0x00};
char * pstr3 =  &charArray3[ 0 ];
String^ szAsciiUpper = gcnew String( pstr3 );
char charArray4[4] = {0x61,0x62,0x63,0x00};
char * pstr4 =  &charArray4[ 0 ];
String^ szAsciiLower = gcnew String( pstr4,0,sizeof(charArray4) );

// Prints "ABC abc"
Console::WriteLine( String::Concat( szAsciiUpper,  " ", szAsciiLower ) );

// Compare Strings - the result is true
Console::WriteLine( String::Concat(  "The Strings are equal when capitalized ? ", (0 == String::Compare( szAsciiUpper->ToUpper(), szAsciiLower->ToUpper() ) ? (String^)"TRUE" :  "FALSE") ) );

// This is the effective equivalent of another Compare method, which ignores case
Console::WriteLine( String::Concat(  "The Strings are equal when capitalized ? ", (0 == String::Compare( szAsciiUpper, szAsciiLower, true ) ? (String^)"TRUE" :  "FALSE") ) );

.NET Framework

All overloads are supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

All overloads are supported in: 4, 3.5 SP1

Portable Class Library

All overloads without an SByte* parameter are supported

.NET for Windows Store apps

All overloads without an SByte* parameter are supported in: Windows 8