EnumerableExtensionsTryRemoveT(IEnumerableT, T, Boolean, Boolean) Method

Tries to remove the specified item from to the collection.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0-preview.1

C#

public static bool TryRemove<T>(
	this IEnumerable<T> collection,
	T item,
	bool checkReadOnly = true,
	bool throwError = true
)

VB

<ExtensionAttribute>
Public Shared Function TryRemove(Of T) ( 
	collection As IEnumerable(Of T),
	item As T,
	Optional checkReadOnly As Boolean = true,
	Optional throwError As Boolean = true
) As Boolean

C++

public:
[ExtensionAttribute]
generic<typename T>
static bool TryRemove(
	IEnumerable<T>^ collection, 
	T item, 
	bool checkReadOnly = true, 
	bool throwError = true
)

F#

[<ExtensionAttribute>]
static member TryRemove : 
        collection : IEnumerable<'T> * 
        item : 'T * 
        ?checkReadOnly : bool * 
        ?throwError : bool 
(* Defaults:
        let _checkReadOnly = defaultArg checkReadOnly true
        let _throwError = defaultArg throwError true
*)
-> bool

Parameters

collection IEnumerableT: The collection to remove the item from.
item T: The item to be removed.
checkReadOnly Boolean (Optional): 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 Boolean (Optional): 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: .

Type Parameters

T: The type of the elements in the collection.

Return Value

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 IEnumerableT. 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 ICollectionT or IList implementation.