EnumerableExtensionsTryRemoveAt(IEnumerable, Int32, Boolean, Boolean) Method

Tries to remove an item at the specified index from the collection.

Definition

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

C#

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

VB

<ExtensionAttribute>
Public Shared Function TryRemoveAt ( 
	collection As IEnumerable,
	index As Integer,
	Optional checkReadOnlyAndBounds As Boolean = true,
	Optional throwError As Boolean = true
) As Boolean

C++

public:
[ExtensionAttribute]
static bool TryRemoveAt(
	IEnumerable^ collection, 
	int index, 
	bool checkReadOnlyAndBounds = true, 
	bool throwError = true
)

F#

[<ExtensionAttribute>]
static member TryRemoveAt : 
        collection : IEnumerable * 
        index : int * 
        ?checkReadOnlyAndBounds : bool * 
        ?throwError : bool 
(* Defaults:
        let _checkReadOnlyAndBounds = defaultArg checkReadOnlyAndBounds true
        let _throwError = defaultArg throwError true
*)
-> bool

Parameters

collection IEnumerable: The collection to remove the item from.
index Int32: The zero-based index of the item to be removed.
checkReadOnlyAndBounds Boolean (Optional): 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 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: .

Return Value

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

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.