Stack::CopyTo Method (Array^, Int32)

 

Copies the Stack to an existing one-dimensional Array, starting at the specified array index.

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

public:
virtual void CopyTo(
	Array^ array,
	int index
)

Parameters

array
Type: System::Array^

The one-dimensional Array that is the destination of the elements copied from Stack. The Array must have zero-based indexing.

index
Type: System::Int32

The zero-based index in array at which copying begins.

Exception Condition
ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than zero.

ArgumentException

array is multidimensional.

-or-

The number of elements in the source Stack is greater than the available space from index to the end of the destination array.

InvalidCastException

The type of the source Stack cannot be cast automatically to the type of the destination array.

The elements are copied onto the array in last-in-first-out (LIFO) order, similar to the order of the elements returned by a succession of calls to Pop.

This method is an O(n) operation, where n is Count.

The following example shows how to copy a Stack into a one-dimensional array.

using namespace System;
using namespace System::Collections;
void PrintValues( Array^ myArr, char mySeparator );
int main()
{
   // Creates and initializes the source Stack.
   Stack^ mySourceQ = gcnew Stack;
   mySourceQ->Push( "barn" );
   mySourceQ->Push( "the" );
   mySourceQ->Push( "in" );
   mySourceQ->Push( "cats" );
   mySourceQ->Push( "napping" );
   mySourceQ->Push( "three" );

   // Creates and initializes the one-dimensional target Array.
   Array^ myTargetArray = Array::CreateInstance( String::typeid, 15 );
   myTargetArray->SetValue( "The", 0 );
   myTargetArray->SetValue( "quick", 1 );
   myTargetArray->SetValue( "brown", 2 );
   myTargetArray->SetValue( "fox", 3 );
   myTargetArray->SetValue( "jumped", 4 );
   myTargetArray->SetValue( "over", 5 );
   myTargetArray->SetValue( "the", 6 );
   myTargetArray->SetValue( "lazy", 7 );
   myTargetArray->SetValue( "dog", 8 );

   // Displays the values of the target Array.
   Console::WriteLine( "The target Array contains the following (before and after copying):" );
   PrintValues( myTargetArray, ' ' );

   // Copies the entire source Stack to the target Array, starting at index 6.
   mySourceQ->CopyTo( myTargetArray, 6 );

   // Displays the values of the target Array.
   PrintValues( myTargetArray, ' ' );

   // Copies the entire source Stack to a new standard array.
   array<Object^>^myStandardArray = mySourceQ->ToArray();

   // Displays the values of the new standard array.
   Console::WriteLine( "The new standard array contains the following:" );
   PrintValues( myStandardArray, ' ' );
}

void PrintValues( Array^ myArr, char mySeparator )
{
   IEnumerator^ myEnum = myArr->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Object^ myObj = safe_cast<Object^>(myEnum->Current);
      Console::Write( "{0}{1}", mySeparator, myObj );
   }

   Console::WriteLine();
}

/* 
 This code produces the following output.

 The target Array contains the following (before and after copying):
  The quick brown fox jumped over the lazy dog      
  The quick brown fox jumped over three napping cats in the barn   
 The new standard array contains the following:
  three napping cats in the barn
 */

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top
Show: