This documentation is archived and is not being maintained.

SoapHeaderCollection::Remove Method

Removes the first occurrence of a specific SoapHeader from the SoapHeaderCollection.

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

public:
void Remove(
	SoapHeader^ header
)

Parameters

header
Type: System.Web.Services.Protocols::SoapHeader

The SoapHeader to remove from the SoapHeaderCollection.

The SoapHeader elements that follow the removed SoapHeader move up to occupy the vacated spot.

// Check to see whether the collection contains mySecondSoapHeader. 
if ( mySoapHeaderCollection->Contains( mySecondSoapHeader ) )
{
   // Get the index of mySecondSoapHeader from the collection.
   Console::WriteLine( "Index of mySecondSoapHeader: {0}", mySoapHeaderCollection->IndexOf( mySecondSoapHeader ) );

   // Get the SoapHeader from the collection.
   MySoapHeader^ mySoapHeader1 = dynamic_cast<MySoapHeader^>(mySoapHeaderCollection[ mySoapHeaderCollection->IndexOf( mySecondSoapHeader ) ]);
   Console::WriteLine( "SoapHeader retrieved from the collection: {0}", mySoapHeader1 );

   // Remove a SoapHeader from the collection.
   mySoapHeaderCollection->Remove( mySoapHeader1 );
   Console::WriteLine( "Number of items after removal: {0}", mySoapHeaderCollection->Count );
}
else
      Console::WriteLine( "mySoapHeaderCollection does not contain mySecondSoapHeader." );
// Check to see whether the collection contains mySecondSoapHeader.
if(mySoapHeaderCollection->Contains(mySecondSoapHeader))
{
   // Get the index of mySecondSoapHeader from the collection.
   Console::WriteLine(S"Index of mySecondSoapHeader: {0}", __box(mySoapHeaderCollection->IndexOf(mySecondSoapHeader)));

   // Get the SoapHeader from the collection.
   MySoapHeader* mySoapHeader1 = dynamic_cast<MySoapHeader*>
      (mySoapHeaderCollection->Item[mySoapHeaderCollection->IndexOf(mySecondSoapHeader)]);
   Console::WriteLine(S"SoapHeader retrieved from the collection: {0}", mySoapHeader1);

   // Remove a SoapHeader from the collection.
   mySoapHeaderCollection->Remove(mySoapHeader1);
   Console::WriteLine(S"Number of items after removal: {0}", __box(mySoapHeaderCollection->Count));
}
else
   Console::WriteLine(
   S"mySoapHeaderCollection does not contain mySecondSoapHeader.");

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

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: