Take (remove) objects from the space matching their IDs and the specified class.
Note, if the space is partitioned and the Class defines a specific property for its routing value (which means that the ID property is not used for routing), the operation will broadcast to all partitions.
FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
ITakeByIdsResult<T> TakeByIds<T>( Object[] ids )
Function TakeByIds(Of T) ( _ ids As Object() _ ) As ITakeByIdsResult(Of T)
generic<typename T> ITakeByIdsResult<T>^ TakeByIds( array<Object^>^ ids )
Generic Template Parameters
- T
- The class.
Parameters
- ids (array< Object >[]()[])
- The object IDs array.
Return Value
An ITakeByIdsResult<(Of <(T>)>) containing the matched results.
Exceptions
Exception | Condition |
---|---|
TakeByIdsException | The operation had a failure. |