KGy SOFT

EnumerableExtensionsTryRemoveAt Method (IEnumerable, Int32, Boolean, Boolean)

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

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

public static bool TryRemoveAt(
	this IEnumerable collection,
	int index,
	bool checkReadOnlyAndBounds = true,
	bool throwError = true
)

Parameters

collection
Type: System.CollectionsIEnumerable
The collection to remove the item from.
index
Type: SystemInt32
The zero-based index of the item to be removed.
checkReadOnlyAndBounds (Optional)
Type: SystemBoolean
 to return  if the collection is read-only or the index is invalid;  to attempt removing the element without checking the read-only state and bounds. 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 a remove method could be successfully called;  if such method was not found, or checkReadOnlyAndBounds is  and the collection was read-only, or throwError is  and the removing 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

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

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

Reference