Removes all matching entries under the specified transaction from the space.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
int Clear( Object template, ITransaction tx, TakeModifiers modifiers )
Function Clear ( _ template As Object, _ tx As ITransaction, _ modifiers As TakeModifiers _ ) As Integer
int Clear( Object^ template, ITransaction^ tx, TakeModifiers modifiers )
int Clear( Object template, ITransaction tx, TakeModifiers modifiers )
Parameters
- template (Object)
- The template/query used for matching.
- tx (ITransaction)
- The transaction (if any) under which to work.
- modifiers (TakeModifiers)
- The modifier(s) to define advanced operation behaviour.
Return Value
Number of removed entries.
Exceptions
Exception | Condition |
---|---|
ClearException | The operation had a failure. |