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

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Exception Condition
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>.

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: