SoapHeaderCollection.Remove(SoapHeader) Method

Definition

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

public:
 void Remove(System::Web::Services::Protocols::SoapHeader ^ header);
public void Remove (System.Web.Services.Protocols.SoapHeader header);
member this.Remove : System.Web.Services.Protocols.SoapHeader -> unit
Public Sub Remove (header As SoapHeader)

Parameters

header
SoapHeader

The SoapHeader to remove from the SoapHeaderCollection.

Examples

// 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("Index of mySecondSoapHeader: " + 
        mySoapHeaderCollection.IndexOf(mySecondSoapHeader));

    // Get the SoapHeader from the collection.
    MySoapHeader mySoapHeader1 = (MySoapHeader)mySoapHeaderCollection
        [mySoapHeaderCollection.IndexOf(mySecondSoapHeader)];
    Console.WriteLine("SoapHeader retrieved from the collection: " 
        + 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) Then
    ' Get the index of mySecondSoapHeader from the collection.
    Console.WriteLine("Index of mySecondSoapHeader: " & _
        mySoapHeaderCollection.IndexOf(mySecondSoapHeader).ToString())

    ' Get the SoapHeader from the collection.
    Dim mySoapHeader1 As MySoapHeader = CType(mySoapHeaderCollection( _
        mySoapHeaderCollection.IndexOf(mySecondSoapHeader)), _
        MySoapHeader)
    Console.WriteLine("SoapHeader retrieved from the collection: " _
        & mySoapHeader1.ToString())

   ' 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.")
End If

Remarks

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

Applies to

See also