ApiSessionClaimPartition Method (SimplePartitionActionArgs) |
Before making any changes to articy objects, the external program needs to claim the partition the object in question resides in.
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public void ClaimPartition( SimplePartitionActionArgs aArgs )
Parameters
- aArgs
- Type: Articy.ApiSimplePartitionActionArgs
An args record that contains the Guid of the partition, the to-be-changed-objects resides in, and the LogSourceName to be used for logging
Remarks
You can query this Guid by using the method GetPartitionId or take it from a PartitionInfo object.
If the partition is already claimed this method returns very fast but without an error.
So it is safe and sound to preventively call ClaimPartition() before making a change to an ObjectProxy.
See Also