ConcurrentStack(Of T).TryPopRange Method (T(), Int32, Int32)

.NET Framework (current version)
 

Attempts to pop and return multiple objects from the top of the ConcurrentStack(Of T) atomically.

Namespace:   System.Collections.Concurrent
Assembly:  mscorlib (in mscorlib.dll)

Public Function TryPopRange (
	items As T(),
	startIndex As Integer,
	count As Integer
) As Integer

Parameters

items
Type: T()

The Array to which objects popped from the top of the ConcurrentStack(Of T) will be added.

startIndex
Type: System.Int32

The zero-based offset in items at which to begin inserting elements from the top of the ConcurrentStack(Of T).

count
Type: System.Int32

The number of elements to be popped from top of the ConcurrentStack(Of T) and inserted into items.

Return Value

Type: System.Int32

The number of objects successfully popped from the top of the stack and inserted in items.

Exception Condition
ArgumentNullException

items is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

startIndex or count is negative. Or startIndex is greater than or equal to the length of items.

ArgumentException

startIndex + count is greater than the length of items.

When popping multiple items, if there is little contention on the stack, using TryPopRange can be more efficient than using TryPop once per item to be removed. Nodes fill the items array with the first item to be popped at the startIndex, the second item to be popped at startIndex + 1, and so on.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: