EnumerableExtensionsTryClear(IEnumerable, Boolean, Boolean) Method

Tries to remove all elements from the collection.

Definition

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

C#

public static bool TryClear(
	this IEnumerable collection,
	bool checkReadOnly = true,
	bool throwError = true
)

VB

<ExtensionAttribute>
Public Shared Function TryClear ( 
	collection As IEnumerable,
	Optional checkReadOnly As Boolean = true,
	Optional throwError As Boolean = true
) As Boolean

C++

public:
[ExtensionAttribute]
static bool TryClear(
	IEnumerable^ collection, 
	bool checkReadOnly = true, 
	bool throwError = true
)

F#

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

Parameters

collection IEnumerable: The collection to clear.
checkReadOnly Boolean (Optional): to return if the collection is read-only; to attempt the clearing without checking the read-only state. This parameter is optional.
Default value: .
throwError Boolean (Optional): to forward any exception thrown by the matching clear method; to suppress inner exceptions and return on failure. This parameter is optional.
Default value: .

Return Value

Boolean
if a clear method could be successfully called; if such method was not found, or checkReadOnly is and the collection was read-only, or throwError is and the clear method threw an exception.

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

The collection can be cleared if that is either an IList, IDictionary or ICollectionT implementation.

Note

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