ApiConsts Class

static class that contains some constants and a error code helper method

Definition

Namespace: Articy.Api
Assembly: PublicApiTypes (in PublicApiTypes.dll) Version: 1.0.0
C#
public static class ApiConsts
Inheritance
Object    ApiConsts

Methods

MakeErrorCode helper method to combine a facility number and an error number to an error code

Fields

ApiFacility the facility number from API reported errors
ErrorCodeMask the bit mask that can be applied to the ErrorCode of an ArticyApiException to extract the error number
FacilityMask the bitmask used to extract the facility number from the ErrorCode of an ArticyApiException. This mask must be applied after shifting down the bits.
FacilityShift the number of bits the facility bits are shifted up (left)
MsgSrcApi the message source used to report API related messages
MsgSrcSystem the message source used to report "system" messages from the underlying articy:draft client
ServerFacility the facility number for articy:server reported errors
SystemFacility the facility code for the "system"

See Also