ConcurrentStack<T>.TryPopRange Method (T[], Int32, Int32)

Attempts to pop and return multiple objects from the top of the ConcurrentStack<T> atomically.

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

public int TryPopRange(
	T[] items,
	int startIndex,
	int count
)

Parameters

items
Type: T[]

The Array to which objects popped from the top of the ConcurrentStack<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<T>.

count
Type: System.Int32

The number of elements to be popped from top of the ConcurrentStack<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.

ExceptionCondition
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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft