ApiSessionDeleteObject Method |
Deletes the given object and all its dependencies.
E.g. when you delete a folder, all elements within will also be deleted;
when you delete a FlowFragment, all inner elements will be deleted, all connected pins and connections to this flow fragment get also deleted
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public void DeleteObject( ObjectProxy aObject )
Parameters
- aObject
- Type: Articy.ApiObjectProxy
the object to be deleted
Exceptions| Exception | Condition |
|---|---|
| ArticyApiException | WriteDenied when the partition containing the object is not claimed |
| ArticyApiException | CantDeleteSystemFolder when you try to delete a system folder |
| ArticyApiException | CantDeletePartitionRoot when you try to delete an object that is the root of an partition |
| ArticyApiException | DeleteNotAllowed any other objection regarding the delete. Most likely that an inner container is the root of an partition |
See Also