This documentation is archived and is not being maintained.

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

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
)

Parameters

items
Type: T[]
The Array to which objects popped from the top of the ConcurrentStack<T> will be added.

Return Value

Type: System.Int32
The number of objects successfully popped from the top of the ConcurrentStack<T> and inserted in items.

ExceptionCondition
ArgumentNullException

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

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.

For a code example, see ConcurrentStack<T>.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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