BlockingCollection<T>.TryAdd Метод

Определение

Пространство имен:

System.Collections.Concurrent

Сборки:

netstandard.dll, System.Collections.Concurrent.dll

Пытается добавить указанный элемент в BlockingCollection<T>объект .

Перегрузки

Имя	Описание
TryAdd(T, Int32)	Пытается добавить указанный элемент в BlockingCollection<T> указанный период времени.
TryAdd(T, Int32, CancellationToken)	Пытается добавить указанный элемент в BlockingCollection<T> указанный период времени, наблюдая за маркером отмены.
TryAdd(T)	Пытается добавить указанный элемент в BlockingCollection<T>объект .
TryAdd(T, TimeSpan)	Пытается добавить указанный элемент в BlockingCollection<T>объект .

TryAdd(T, Int32)

Исходный код:

BlockingCollection.cs

Пытается добавить указанный элемент в BlockingCollection<T> указанный период времени.

public:
 bool TryAdd(T item, int millisecondsTimeout);

public bool TryAdd(T item, int millisecondsTimeout);

member this.TryAdd : 'T * int -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer) As Boolean

Параметры

item

T

Элемент, добавляемый в коллекцию.

millisecondsTimeout

Int32

Количество миллисекундах, ожидающее, пока коллекция примет элемент или Infinite (-1) ждать неограниченное время.

Возвращаемое значение

Boolean

true item Значение false, если его можно добавить в коллекцию в течение указанного времени; в противном случае — значение false. Если элемент является дубликатом, а базовая коллекция не принимает повторяющиеся элементы, InvalidOperationException создается исключение.

Исключения

ObjectDisposedException

Он BlockingCollection<T> был удален.

ArgumentOutOfRangeException

millisecondsTimeout — отрицательное число, отличное от -1, которое представляет бесконечное время ожидания.

InvalidOperationException

Он BlockingCollection<T> помечен как полный в отношении добавлений.

–или–

Базовая коллекция не приняла элемент.

См. также раздел

• Thread-Safe коллекций
• Обзор BlockingCollection

TryAdd(T, Int32, CancellationToken)

Исходный код:

BlockingCollection.cs

Пытается добавить указанный элемент в BlockingCollection<T> указанный период времени, наблюдая за маркером отмены.

public:
 bool TryAdd(T item, int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);

public bool TryAdd(T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);

member this.TryAdd : 'T * int * System.Threading.CancellationToken -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

Параметры

item

T

Элемент, добавляемый в коллекцию.

millisecondsTimeout

Int32

Количество миллисекундах, ожидающее, пока коллекция примет элемент или Infinite (-1) ждать неограниченное время.

cancellationToken

CancellationToken

Маркер отмены для наблюдения.

Возвращаемое значение

Boolean

true item Значение false, если его можно добавить в коллекцию в течение указанного времени; в противном случае — значение false. Если элемент является дубликатом, а базовая коллекция не принимает повторяющиеся элементы, InvalidOperationException создается исключение.

Исключения

OperationCanceledException

Отмена CancellationToken .

ObjectDisposedException

Он BlockingCollection<T> был удален или базовый CancellationTokenSource был удален.

ArgumentOutOfRangeException

millisecondsTimeout — отрицательное число, отличное от -1, которое представляет бесконечное время ожидания.

InvalidOperationException

Он BlockingCollection<T> помечен как полный в отношении добавлений.

–или–

Базовая коллекция не приняла элемент.

См. также раздел

• Thread-Safe коллекций
• Обзор BlockingCollection

TryAdd(T)

Исходный код:

BlockingCollection.cs

Пытается добавить указанный элемент в BlockingCollection<T>объект .

public:
 bool TryAdd(T item);

public bool TryAdd(T item);

member this.TryAdd : 'T -> bool

Public Function TryAdd (item As T) As Boolean

Параметры

item

T

Элемент, добавляемый в коллекцию.

Возвращаемое значение

Boolean

trueЗначение , itemесли false может быть добавлено; в противном случае . Если элемент является дубликатом, а базовая коллекция не принимает повторяющиеся элементы, InvalidOperationException создается исключение.

Исключения

ObjectDisposedException

Он BlockingCollection<T> был удален.

InvalidOperationException

Он BlockingCollection<T> помечен как полный в отношении добавлений.

–или–

Базовая коллекция не приняла элемент.

Комментарии

Если коллекция является привязанной коллекцией и заполнена, этот метод немедленно возвращает значение false, не добавляя элемент.

См. также раздел

• Thread-Safe коллекций
• Обзор BlockingCollection

TryAdd(T, TimeSpan)

Исходный код:

BlockingCollection.cs

Пытается добавить указанный элемент в BlockingCollection<T>объект .

public:
 bool TryAdd(T item, TimeSpan timeout);

public bool TryAdd(T item, TimeSpan timeout);

member this.TryAdd : 'T * TimeSpan -> bool

Public Function TryAdd (item As T, timeout As TimeSpan) As Boolean

Параметры

item

T

Элемент, добавляемый в коллекцию.

timeout

TimeSpan

Значение TimeSpan , представляющее количество миллисекунда для ожидания, или значение TimeSpan , представляющее -1 миллисекундах, которые будут ждать неограниченное время.

Возвращаемое значение

Boolean

true item Значение , если его можно добавить в коллекцию в течение указанного интервала времени; в противном случае false.

Исключения

ObjectDisposedException

Он BlockingCollection<T> был удален.

ArgumentOutOfRangeException

timeout — отрицательное число, отличное от -1 миллисекунда, которое представляет бесконечное время ожидания

–или–

timeout больше int32.MaxValue.

InvalidOperationException

Он BlockingCollection<T> помечен как полный в отношении добавлений.

–или–

Базовая коллекция не приняла элемент.

См. также раздел

• Thread-Safe коллекций
• Обзор BlockingCollection