Take (remove) objects from the space matching the specified ids query,
with the provided TakeModifiers.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
ITakeByIdsResult<T> TakeByIds<T>( IdsQuery<T> idsQuery, ITransaction tx, TakeModifiers modifiers )
Function TakeByIds(Of T) ( _ idsQuery As IdsQuery(Of T), _ tx As ITransaction, _ modifiers As TakeModifiers _ ) As ITakeByIdsResult(Of T)
generic<typename T> ITakeByIdsResult<T>^ TakeByIds( IdsQuery<T> idsQuery, ITransaction^ tx, TakeModifiers modifiers )
Generic Template Parameters
- T
- Type of expected result entry.
Parameters
- idsQuery (IdsQuery<(Of <(<'T>)>)>)
- The query to search by.
- tx (ITransaction)
- The transaction which this operation will participate in.
- modifiers (TakeModifiers)
- The read modifier to use (One or several of ).
Return Value
An ITakeByIdsResult<(Of <(<'T>)>)> containing the matched results.
Exceptions
Exception | Condition |
---|---|
TakeByIdsException | The operation had a failure. |