IVsaItems.Remove(String) Method
Removes an item from the collection, as specified by its name.
public: void Remove(
String* Name
);
public void Remove(
string Name
);
MustOverride Overloads Public Sub Remove( _
ByVal Name As String _
)
Parameters
- name
The name of the item to be removed from the collection.
Remarks
This is an overloaded method that removes the specified item from the collection using the name parameter, which must be identical to the IVsaItem.Name property of the item in the collection.
Upon removing an item, the IVsaEngine.IsDirty property returns true until the IVsaEngine.SaveSourceState method is called.
The following table shows the exceptions that the Remove(String) method can throw.
Exception Type |
Condition |
---|---|
EngineClosed |
The IVsaEngine.Close method has been called and the engine is closed. |
EngineNotInitialized |
The engine has not been initialized. |
EngineRunning |
The engine is running. |
ItemNotFound |
The item was not found in the collection. |