EnumerableExtensionsTryClear Method (IEnumerable, Boolean, Boolean)

KGy SOFT Core Libraries Help
Tries to remove all elements from the collection.

Namespace:  KGySoft.CoreLibraries
Assembly:  KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 6.0.0

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


Type: System.CollectionsIEnumerable
The collection to clear.
checkReadOnly (Optional)
Type: SystemBoolean
 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 (Optional)
Type: SystemBoolean
 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

Type: 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).

The collection can be cleared if that is either an IList, IDictionary 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 TryClear<T> overload if possible.
See Also