Takes (removes) an entry matching the specified id query from the space.
Blocks up to the specified timeout (if any) only if a matching entry exists and it is
necessary to wait for transactional state to settle.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
T TakeIfExistsById<T>( IdQuery<T> idQuery, ITransaction tx, long timeout, TakeModifiers modifiers )
Function TakeIfExistsById(Of T) ( _ idQuery As IdQuery(Of T), _ tx As ITransaction, _ timeout As Long, _ modifiers As TakeModifiers _ ) As T
generic<typename T> T TakeIfExistsById( IdQuery<T>^ idQuery, ITransaction^ tx, long long timeout, TakeModifiers modifiers )
Generic Template Parameters
- T
- Type of expected result entry.
Parameters
- idQuery (IdQuery<(Of <(<'T>)>)>)
- The query to search by.
- tx (ITransaction)
- The transaction which this operation will participate in.
- timeout (Int64)
- The maximum time to wait for a transactionally proper matching object.
- modifiers (TakeModifiers)
- Additional modifiers to control operation behaviour.
Return Value
Result entry from space (null if not found).