KGy SOFT

EnumerableExtensionsTryRemove Method (IEnumerable, Object, Boolean, Boolean)

KGy SOFT Core Libraries Help
Tries to remove the specified item from to the collection.

Namespace:  KGySoft.CoreLibraries
Assembly:  KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 5.0.0
Syntax

public static bool TryRemove(
	this IEnumerable collection,
	Object item,
	bool checkReadOnly = true,
	bool throwError = true
)

Parameters

collection
Type: System.CollectionsIEnumerable
The collection to remove the item from.
item
Type: SystemObject
The item to be removed.
checkReadOnly (Optional)
Type: SystemBoolean
 to return  if the collection is read-only;  to attempt removing the element without checking the read-only state. This parameter is optional.
Default value: .
throwError (Optional)
Type: SystemBoolean
 to forward any exception thrown by a found remove method;  to suppress the exceptions thrown by the found remove method and return  on failure. This parameter is optional.
Default value: .

Return Value

Type: Boolean
 if item could be successfully removed;  if a removing method was not found or the item could not be removed, checkReadOnly is  and the collection was read-only, throwError is  and the removing method threw an exception, or the removing method returned .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks

Removal is supported if collection is either an IList or ICollectionT implementation.

Note Note
If it is known that the collection implements only the supported generic ICollectionT interface, then for better performance use the generic TryRemove<T> overload if possible.
See Also

Reference