ApiSessionClaimPartitions Method (IEnumerableObjectProxy, String, ListGuid, DictionaryGuid, Exception) |
Claims all distinct partitions required for the given list of objects.
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
SyntaxC#
public void ClaimPartitions( IEnumerable<ObjectProxy> aObjects, string aLogName, ref List<Guid> aClaimedPartitions, ref Dictionary<Guid, Exception> aFailedPartitions )
Parameters
- aObjects
- Type: System.Collections.GenericIEnumerableObjectProxy
the list of object objects whose partitions should be claimed - aLogName
- Type: SystemString
the log source name to be used for progress output - aClaimedPartitions
- Type: System.Collections.GenericListGuid
the list of successful claimed partitions, in case of an exception these partitions should be unclaimed - aFailedPartitions
- Type: System.Collections.GenericDictionaryGuid, Exception
a dictionary of partitions whose claiming has failed, including the exception with the reason
Remarks
Providing null for aClaimedPartition will not record successful claimed partitions.
Providing null for aFailedPartitions will throw an exception on the first partition that could not be claimed.
You should check aFailedPartitions.Count to check if there were any exceptions.
Partitions that are already claimed within the list of objects are reported as claimed, even if there is no data transfer required.
See Also