Cross Point


Global enumerations


Detailed Description

Global enumerations.


Enumerations

enum  TalosAPILib::EDISPIDS {
  TalosAPILib::DISPID_OnProcessStarted = 0x01,
  TalosAPILib::DISPID_OnProcessFinished = 0x02,
  TalosAPILib::DISPID_OnProcessInfo = 0x03
}
 ID's for the different events that can be fired by the API. More...

enum  TalosAPILib::EReaderResults {
  TalosAPILib::E_GENERALERROR = 0x80040201,
  TalosAPILib::E_GENERALERROR2 = 0x80040202,
  TalosAPILib::E_GENERALERROR3 = 0x80040203,
  TalosAPILib::E_GENERALERROR4 = 0x80040204,
  TalosAPILib::E_GENERALERROR5 = 0x80040205,
  TalosAPILib::E_GENERALERROR6 = 0x80040206,
  TalosAPILib::E_GENERALERROR7 = 0x80040207,
  TalosAPILib::S_INPROGRESS = 0x000402FF,
  TalosAPILib::E_INCORRECTCHECKSUM = 0x800402F0,
  TalosAPILib::E_WRONGHWMODE = 0x800402F1,
  TalosAPILib::E_NOTCONNECTED = 0x800402F2,
  TalosAPILib::E_TIMEOUT = 0x800402F3,
  TalosAPILib::E_ENCODEFAILED = 0x800402F4,
  TalosAPILib::E_FILENOTFOUND = 0x800402F5,
  TalosAPILib::E_UNKNOWN = 0x800402F6,
  TalosAPILib::E_NOTCOLLECTED = 0x800402F7,
  TalosAPILib::E_COMMANDINPROGRESS = 0x80040300,
  TalosAPILib::E_NOTAVAILABLE = 0x800402FC,
  TalosAPILib::E_NOTSUPPORTED = 0x800402FD,
  TalosAPILib::E_NOTAUTHORIZED = 0x800402FE
}
 Custom error messages. More...

enum  TalosAPILib::ELogonLevel {
  TalosAPILib::llUnknown = 0x0000,
  TalosAPILib::llUser = 0x0001,
  TalosAPILib::llInstaller = 0x0002
}
 Enumeration for the logon level used in the reader. More...

enum  TalosAPILib::EUserLevel {
  TalosAPILib::ulNormalUser = 0x0000,
  TalosAPILib::ulSpecialUser = 0x0001,
  TalosAPILib::ulNightLockOnlyUser = 0x0002,
  TalosAPILib::ulUnlockMaster = 0x0005,
  TalosAPILib::ulKeypadProgrammer = 0x0006,
  TalosAPILib::ulNightLockMaster = 0x0007,
  TalosAPILib::ulAddMaster = 0x0008,
  TalosAPILib::ulVoidMaster = 0x0009,
  TalosAPILib::ulProgramMaster = 0x000A,
  TalosAPILib::ulInstallerProgrammer = 0x000B,
  TalosAPILib::ulUserProgrammer = 0x000C
}
 Enumeration for the user level used in the reader. More...

enum  TalosAPILib::ECardType {
  TalosAPILib::ctCrossPoint = 0x0000,
  TalosAPILib::ctHID_H10301_26 = 0x0001,
  TalosAPILib::ctHID_H10306_34 = 0x0002,
  TalosAPILib::ctHID_Corporate1000 = 0x0003,
  TalosAPILib::ctHID_H10302_37 = 0x0004,
  TalosAPILib::ctHID_H10304_37 = 0x0005,
  TalosAPILib::ctMifareStandard = 0x0008,
  TalosAPILib::ctEMMarin = 0x0009
}
 Enumeration for the different ECardTypes used in the reader. More...

enum  TalosAPILib::ERFIDMode {
  TalosAPILib::rmDisabled = 0x0000,
  TalosAPILib::rmReceive = 0x0100,
  TalosAPILib::rmTransmitExtClock = 0x0200,
  TalosAPILib::rmTransmitIntClock = 0x0201
}
 Defined RFID modes. More...

enum  TalosAPILib::ELoggingMode {
  TalosAPILib::lmDisabled = 0x0000,
  TalosAPILib::lmAlways = 0x0001,
  TalosAPILib::lmDynamic = 0x0002,
  TalosAPILib::lmUnknown = 0x00FF
}
 Specifies the logging modes. More...

enum  TalosAPILib::ELoggingOptions {
  TalosAPILib::loUnknown = 0x0000,
  TalosAPILib::loSecurity = 0x0001,
  TalosAPILib::loLogConfig = 0x0002,
  TalosAPILib::loLogStatus = 0x0004,
  TalosAPILib::loUser = 0x0008,
  TalosAPILib::loDestructiveRead = 0x0010,
  TalosAPILib::loAll = loSecurity | loLogConfig | loLogStatus | loUser | loDestructiveRead
}
 Specifies the categories that should be logged. More...

enum  TalosAPILib::EBaudrate {
  TalosAPILib::br9600 = 9600,
  TalosAPILib::br19200 = 19200,
  TalosAPILib::br38400 = 38400,
  TalosAPILib::br57600 = 57600,
  TalosAPILib::br115200 = 115200
}
 Specifies communication baudrate. More...

enum  TalosAPILib::EWeekScheme {
  TalosAPILib::wsUnknown = 0x0000,
  TalosAPILib::wsSunday = 0x0001,
  TalosAPILib::wsMonday = 0x0002,
  TalosAPILib::wsTuesday = 0x0004,
  TalosAPILib::wsWednesday = 0x0008,
  TalosAPILib::wsThursday = 0x0010,
  TalosAPILib::wsFriday = 0x0020,
  TalosAPILib::wsSaturday = 0x0040,
  TalosAPILib::wsAlways = 0x00FF
}
 Time zone week scheme. More...

enum  TalosAPILib::ELockType { ,
  TalosAPILib::ltNormallyOpen = 0x0001,
  TalosAPILib::ltNormallyClosed = 0x0002,
  TalosAPILib::ltCodedSignal = 0x0003
}
 Enumeration for the door lock type. More...

enum  TalosAPILib::EEventDataType {
  TalosAPILib::edNone = 0,
  TalosAPILib::edUser = 1,
  TalosAPILib::edSystemParameter = 2,
  TalosAPILib::edParameter = 3,
  TalosAPILib::edUserLevel = 4,
  TalosAPILib::edClock = 5,
  TalosAPILib::edTestNumber = 6,
  TalosAPILib::edErrorNumber = 7,
  TalosAPILib::edUserGroupID = 8,
  TalosAPILib::edTimeSchemeID = 9
}
 The different event data types. More...

enum  TalosAPILib::EEventClass {
  TalosAPILib::ecSecurity = 0,
  TalosAPILib::ecConfiguration = 1,
  TalosAPILib::ecStatus = 2,
  TalosAPILib::ecUserDefined = 3,
  TalosAPILib::ecUnknown = 255
}
 The different event data classes. More...

enum  TalosAPILib::EOperationalMode {
  TalosAPILib::omStartUp = 0,
  TalosAPILib::omSleep = 1,
  TalosAPILib::omAccess = 2,
  TalosAPILib::omNightLock = 3,
  TalosAPILib::omAdd = 4,
  TalosAPILib::omVoid = 5,
  TalosAPILib::omProgram = 6,
  TalosAPILib::omNetwork = 7,
  TalosAPILib::omDemo = 8,
  TalosAPILib::omRQD = 9,
  TalosAPILib::omCount = 10,
  TalosAPILib::omSelfTest = 11,
  TalosAPILib::omCopy = 12,
  TalosAPILib::omKeyPad = 13,
  TalosAPILib::omWiegand = 14,
  TalosAPILib::omMagStripe = 15,
  TalosAPILib::omSID = 16
}
 Enumeration for different reader operational modes. More...

enum  TalosAPILib::ESoftwareConfiguration {
  TalosAPILib::scDefault = 0,
  TalosAPILib::scBasic = 1,
  TalosAPILib::scAdvanced = 2,
  TalosAPILib::scStandAlone = 3,
  TalosAPILib::scUnknown = 255
}
 Enumeration for different reader software configurations. More...

enum  TalosAPILib::ESoftwareMode {
  TalosAPILib::smNone = 0x00,
  TalosAPILib::smUnknown = 0x0C,
  TalosAPILib::smBootloader = 0x0D,
  TalosAPILib::smApplication = 0x0E,
  TalosAPILib::smNoReaderFound = 0xFF
}
 Enumeration for different reader software modes. More...

enum  TalosAPILib::ENVP {
  TalosAPILib::nvpFirst = 0,
  TalosAPILib::nvpSerialNumber = 0,
  TalosAPILib::nvpHardwareVersion = 1,
  TalosAPILib::nvpExtensionBoardType = 2,
  TalosAPILib::nvpExtensionBoardVersion = 3,
  TalosAPILib::nvpBootloaderVersion = 4,
  TalosAPILib::nvpOSVersion = 5,
  TalosAPILib::nvpApplicationVersion = 6,
  TalosAPILib::nvpSoftwareConfiguration = 7,
  TalosAPILib::nvpSoftwareConfigurationKey = 8,
  TalosAPILib::nvpNetworkAddress = 9,
  TalosAPILib::nvpOperationalMode = 10,
  TalosAPILib::nvpLevel = 11,
  TalosAPILib::nvpLockType = 12,
  TalosAPILib::nvpDoorOpenTime = 13,
  TalosAPILib::nvpDoorCloseTime = 14,
  TalosAPILib::nvpInactivityTime = 15,
  TalosAPILib::nvpUserOptions = 16,
  TalosAPILib::nvpInstallerOptions = 17,
  TalosAPILib::nvpSystemOptions = 18,
  TalosAPILib::nvpNetworkPollTime = 19,
  TalosAPILib::nvpKeypadOptions = 20,
  TalosAPILib::nvpAlarmCode = 21,
  TalosAPILib::nvpAccessCode = 22,
  TalosAPILib::nvpChangeCode = 23,
  TalosAPILib::nvpUserLevelPassword = 24,
  TalosAPILib::nvpInstallerLevelPassword = 25,
  TalosAPILib::nvpEventLogMode = 26,
  TalosAPILib::nvpEventLogOptions = 27,
  TalosAPILib::nvpUnlockzoneUnlockToLockMarker = 28,
  TalosAPILib::nvpUnlockzoneLockToUnlockMarker = 29,
  TalosAPILib::nvpUnlockzoneWeekscheme = 30,
  TalosAPILib::nvpPrinterEnable = 31,
  TalosAPILib::nvpAntiPassbackMode = 33,
  TalosAPILib::nvpAntiPassbackTime = 34,
  TalosAPILib::nvpTimezoneNightToDayMarker = 35,
  TalosAPILib::nvpTimezoneDayToNightMarker = 36,
  TalosAPILib::nvpTimezoneWeekscheme = 37,
  TalosAPILib::nvpDeviceName = 38,
  TalosAPILib::nvpCurrentFileSystem = 39,
  TalosAPILib::nvpMagstripeOutputFormat = 40,
  TalosAPILib::nvpMagstripeOutputOptions = 41,
  TalosAPILib::nvpMagstripeStartBits = 42,
  TalosAPILib::nvpMagstripeStopBits = 43,
  TalosAPILib::nvpWiegandOutputFormat = 44,
  TalosAPILib::nvpWiegandOutputOptions = 45,
  TalosAPILib::nvpBaudrate = 46,
  TalosAPILib::nvpCharacterFrame = 47,
  TalosAPILib::nvpDefaultUserGroup = 48,
  TalosAPILib::nvpCardReadOptions = 49,
  TalosAPILib::nvpLast = 60,
  TalosAPILib::nvpUnknown = 255
}
 Enumeration for all NVPs. For a more detailed description: see the master manual. More...

enum  TalosAPILib::ENVPType {
  TalosAPILib::ntUnsignedNumber = 0,
  TalosAPILib::ntBitflags = 1,
  TalosAPILib::ntString = 2,
  TalosAPILib::ntUnknown = 255
}
 Enumeration for the different NVP data types. More...

enum  TalosAPILib::EAsyncMode {
  TalosAPILib::amDefault = 0,
  TalosAPILib::amSync = 1,
  TalosAPILib::amAsync = 2
}
 Enumeration for the different synchronization modes. More...

enum  TalosAPILib::EFileType {
  TalosAPILib::ftUnknown = 0,
  TalosAPILib::ftXML = 1,
  TalosAPILib::ftCSV = 2,
  TalosAPILib::ftSimpleData = 4,
  TalosAPILib::ftHTML = 8
}
 Enumeration for the different output/input file types. More...

enum  TalosAPILib::EUserConfiguration {
  TalosAPILib::ucUnknown = 0,
  TalosAPILib::ucID = 1,
  TalosAPILib::ucPincode = 2,
  TalosAPILib::ucName = 4,
  TalosAPILib::ucValidPeriod = 8,
  TalosAPILib::ucUserGroups = 16
}
 Enumeration for the user database configuration. More...

enum  TalosAPILib::EVersionType {
  TalosAPILib::vtHardware = 0,
  TalosAPILib::vtBootloader = 1,
  TalosAPILib::vtOS = 2,
  TalosAPILib::vtApplication = 3,
  TalosAPILib::vtExtensionBoard = 4,
  TalosAPILib::vtFirmware = 5
}
 Enumeration for the GetVersion method, to able the GetVersion method to return different versions. More...

enum  TalosAPILib::EExtensionBoardType {
  TalosAPILib::etNone = 0,
  TalosAPILib::etMifare = 3,
  TalosAPILib::etHID = 32,
  TalosAPILib::etLongRange = 64
}
 Enumeration for the extension board type. More...

enum  TalosAPILib::EUploadOptions
 Enumeration for the different upload types. More...

enum  TalosAPILib::EFlashArea {
  TalosAPILib::faUnknown = 0x00,
  TalosAPILib::faOS = 0x01,
  TalosAPILib::faApplication = 0x02,
  TalosAPILib::faFirmware = 0x04
}
 Defined flash areas. More...

enum  TalosAPILib::EMemoryType {
  TalosAPILib::mtUnknown = 0,
  TalosAPILib::mtProcessor = 1,
  TalosAPILib::mtSerialEEPROM = 2,
  TalosAPILib::mtFlash = 3
}
 Enumeration for different reader memory types. More...

enum  TalosAPILib::ELEDState {
  TalosAPILib::lsNone = 0x0000,
  TalosAPILib::lsYellow = 0x0001,
  TalosAPILib::lsGreen = 0x0002,
  TalosAPILib::lsRed1 = 0x0004,
  TalosAPILib::lsRed2 = 0x0008,
  TalosAPILib::lsRed3 = 0x0010,
  TalosAPILib::lsRed4 = 0x0020,
  TalosAPILib::lsRed5 = 0x0040,
  TalosAPILib::lsAll = 0x00FF
}
 Enumeration for different state of the LEDs on the reader. More...

enum  TalosAPILib::EIOContacts {
  TalosAPILib::ioNone = 0x0000,
  TalosAPILib::io1 = 0x0001,
  TalosAPILib::io2 = 0x0002,
  TalosAPILib::io3 = 0x0004,
  TalosAPILib::io4 = 0x0008,
  TalosAPILib::ioAll = 0x00FF
}
 Enumeration for different IO contacts on the reader. More...

enum  TalosAPILib::EBuzzerState {
  TalosAPILib::bzNoSound = 0,
  TalosAPILib::bzShortBeep = 2,
  TalosAPILib::bzMediumBeep = 6,
  TalosAPILib::bzLongBeep = 10,
  TalosAPILib::bzVeryLongBeep = 15,
  TalosAPILib::bzContinuosly = 18,
  TalosAPILib::bzErrorBeep = 20
}
 Enumeration for the different buzzer states (sounds). More...

enum  TalosAPILib::ECopyFlags {
  TalosAPILib::cfNone = 0x0000,
  TalosAPILib::cfUsers = 0x0001,
  TalosAPILib::cfParameters = 0x0002,
  TalosAPILib::cfHolidays = 0x0004,
  TalosAPILib::cfFileSystem = 0x0008,
  TalosAPILib::cfClearUsers = 0x0010,
  TalosAPILib::cfAll = cfUsers | cfParameters | cfHolidays | cfFileSystem
}
 Enumeration for the CopyFrom method. More...

enum  TalosAPILib::EProcessType {
  TalosAPILib::ptNone = 0x0000,
  TalosAPILib::ptApplicationChange = 0x0001,
  TalosAPILib::ptNetworkChange = 0x0002,
  TalosAPILib::ptUserdatabaseChange = 0x0003,
  TalosAPILib::ptEventdatabaseChange = 0x0004,
  TalosAPILib::ptParameterdatabaseChange = 0x0005 ,
  TalosAPILib::ptFindingNetwork = 0x0100,
  TalosAPILib::ptScanningNetworks = 0x0110,
  TalosAPILib::ptArchivingEvents = 0x0120,
  TalosAPILib::ptFindingReader = 0x0200,
  TalosAPILib::ptScanningReaders = 0x0210,
  TalosAPILib::ptChangingNetworkSettings = 0x0220,
  TalosAPILib::ptCheckingReaderPresence = 0x0230,
  TalosAPILib::ptSettingFileSystem = 0x0300,
  TalosAPILib::ptResetting = 0x0310,
  TalosAPILib::ptUpgradeSWConfiguration = 0x0320,
  TalosAPILib::ptCopyingReader = 0x0330,
  TalosAPILib::ptCollectingHolidays = 0x0340,
  TalosAPILib::ptAddingHolidays = 0x0350,
  TalosAPILib::ptChangingNetworkAddress = 0x0360,
  TalosAPILib::ptCopyFrom = 0x0370,
  TalosAPILib::ptRemovingHolidays = 0x0380,
  TalosAPILib::ptCollectingTimeSchemes = 0x0390,
  TalosAPILib::ptUploading = 0x0400,
  TalosAPILib::ptCollectingUsers = 0x0500,
  TalosAPILib::ptClearingUsers = 0x0510,
  TalosAPILib::ptSearchingUsers = 0x0520,
  TalosAPILib::ptSettingUsers = 0x0530,
  TalosAPILib::ptCollectingUserGroups = 0x0540,
  TalosAPILib::ptRemovingExpiredUsers = 0x0550,
  TalosAPILib::ptCollectingEvents = 0x0600,
  TalosAPILib::ptClearingEvents = 0x0610,
  TalosAPILib::ptSearchingEvents = 0x0620,
  TalosAPILib::ptUploadingFirmware = 0x0700,
  TalosAPILib::ptErasingFirmware = 0x0710,
  TalosAPILib::ptWritingMemory = 0x0720,
  TalosAPILib::ptUploadingOS = 0x0730,
  TalosAPILib::ptUploadingCPA = 0x0740,
  TalosAPILib::ptCollectingParameters = 0x0800,
  TalosAPILib::ptSettingParameters = 0x0810,
  TalosAPILib::ptParameterSaved = 0x0900,
  TalosAPILib::ptSearching = 0x0A00,
  TalosAPILib::ptCollectingTimeBlocks = 0x0B00
}
 Enumeration for the status of a process. Used when firing events. More...

enum  TalosAPILib::ESubProcessType {
  TalosAPILib::sptProgress = 0x0000,
  TalosAPILib::sptItemAdded = 0x0001,
  TalosAPILib::sptItemRemoved = 0x0002,
  TalosAPILib::sptItemModified = 0x0003,
  TalosAPILib::sptItemFound = 0x0004,
  TalosAPILib::sptItemFailed = 0x0005,
  TalosAPILib::sptCleared = 0x0006,
  TalosAPILib::sptItemMask = 0x000F,
  TalosAPILib::sptFindingNetwork = 0x0100,
  TalosAPILib::sptSettingFileSystem = 0x0300,
  TalosAPILib::sptResetting = 0x0310,
  TalosAPILib::sptCollectingHolidays = 0x0340,
  TalosAPILib::sptAddingHolidays = 0x0350,
  TalosAPILib::sptRemovingHolidays = 0x0380,
  TalosAPILib::sptCollectingUsers = 0x0500,
  TalosAPILib::sptClearingUsers = 0x0510,
  TalosAPILib::sptSearchingUsers = 0x0520,
  TalosAPILib::sptSettingUsers = 0x0530,
  TalosAPILib::sptSearchingEvents = 0x0620,
  TalosAPILib::sptErasingFirmware = 0x0710,
  TalosAPILib::sptUploadingOS = 0x0730,
  TalosAPILib::sptUploadingCPA = 0x0740,
  TalosAPILib::sptCollectingParameters = 0x0800,
  TalosAPILib::sptSettingParameters = 0x0810,
  TalosAPILib::sptSubProcessMask = 0x0FF0,
  TalosAPILib::sptInfo = 0x0000,
  TalosAPILib::sptStarted = 0x1000,
  TalosAPILib::sptFinished = 0x2000,
  TalosAPILib::sptStatusMask = 0xF000
}
 Enumeration for the sub process type of a OnProcessInfo event. More...

enum  TalosAPILib::EProgressType { TalosAPILib::ptUnknown = 0x0000 }
 Enumeration for the ProximityReader's Progress event. More...

enum  TalosAPILib::ECollectingStatus {
  TalosAPILib::csUnknown = 0x0000,
  TalosAPILib::csNotCollected = 0x0001,
  TalosAPILib::csBusy = 0x0002,
  TalosAPILib::csCollected = 0x0003,
  TalosAPILib::csReady = csCollected
}
 Enumeration for the status of a collecting process. More...

enum  TalosAPILib::ESearchFlags {
  TalosAPILib::sfNone = 0x0000,
  TalosAPILib::sfSearchAsync = 0x0001,
  TalosAPILib::sfSearchAllReaders = 0x0002,
  TalosAPILib::sfUsers = 0x0100,
  TalosAPILib::sfEvents = 0x0200,
  TalosAPILib::sfClearResults = 0x2000,
  TalosAPILib::sfSearchResults2 = 0x8000
}
 Enumeration for the different search flags. More...

enum  TalosAPILib::ESearchStatus {
  TalosAPILib::ssUnknown = 0x0000,
  TalosAPILib::ssNoSearchResults = 0x0001,
  TalosAPILib::ssSearchingUsers = 0x0002,
  TalosAPILib::ssSearchingEvents = 0x0004,
  TalosAPILib::ssBusy = 0x0006,
  TalosAPILib::ssReadersBusy = 0x0008,
  TalosAPILib::ssUsersSearched = 0x0020,
  TalosAPILib::ssEventsSearched = 0x0040,
  TalosAPILib::ssSearched = 0x0060,
  TalosAPILib::ssReady = ssSearched
}
 Enumeration for the status of search processes. More...

enum  TalosAPILib::EUserGroupFlags {
  TalosAPILib::ugfNone = 0x0000,
  TalosAPILib::ugfOverruleHolidays = 0x0001
}
 Enumeration for the different flags of a usergroup. More...

enum  TalosAPILib::ETimeSchemeDay {
  TalosAPILib::tsdSunday = 0x0000,
  TalosAPILib::tsdMonday = 0x0001,
  TalosAPILib::tsdTuesday = 0x0002,
  TalosAPILib::tsdWednesday = 0x0003,
  TalosAPILib::tsdThursday = 0x0004,
  TalosAPILib::tsdFriday = 0x0005,
  TalosAPILib::tsdSaturday = 0x0006,
  TalosAPILib::tsdUnknown = 0x000F
}
 Time scheme day numbers. More...

enum  TalosAPILib::EArchiveEventsOptions {
  TalosAPILib::aeoAllEvents = 0x0000,
  TalosAPILib::aeoSecurityEventsOnly = 0x0001
}
 Options for the archive events method. More...


Enumeration Type Documentation

enum TalosAPILib::EDISPIDS
 

ID's for the different events that can be fired by the API.

Enumeration values:
DISPID_OnProcessStarted  IProcessEvent::OnProcessStarted.
DISPID_OnProcessFinished  IProcessEvent::OnProcessFinished.
DISPID_OnProcessInfo  IProcessEvent::OnProcessInfo.

enum TalosAPILib::EReaderResults
 

Custom error messages.

Enumeration values:
E_GENERALERROR  A general error 1 has occurred.
E_GENERALERROR2  A general error 2 has occurred.
E_GENERALERROR3  A general error 3 has occurred.
E_GENERALERROR4  A general error 4 has occurred.
E_GENERALERROR5  A general error 5 has occurred.
E_GENERALERROR6  A general error 6 has occurred.
E_GENERALERROR7  A general error 7 has occurred.
S_INPROGRESS  Message still in progress.
E_INCORRECTCHECKSUM  Incorrect checksum on incoming message.
E_WRONGHWMODE  Wrong hardware mode to perform this action (try bootloader mode).
E_NOTCONNECTED  Not connected to a XM3.
E_TIMEOUT  A timeout occurred while waiting for a reply from the XM3.
E_ENCODEFAILED  The encoding proces failed (not enough memory?).
E_FILENOTFOUND  A file was not found.
E_UNKNOWN  An unknown error has occurred.
E_NOTCOLLECTED  The sub-elements are not yet collected, collect them first before using this method.
E_COMMANDINPROGRESS  Another command is busy processing async, wait until that command has finished!
E_NOTAVAILABLE  Parameter not available.
E_NOTSUPPORTED  Functionality not supported.
E_NOTAUTHORIZED  You are not authorized to perform this action (logon first).

enum TalosAPILib::ELogonLevel
 

Enumeration for the logon level used in the reader.

Enumeration values:
llUnknown  Unknown level.
llUser  User level.
llInstaller  Installer level.

enum TalosAPILib::EUserLevel
 

Enumeration for the user level used in the reader.

Enumeration values:
ulNormalUser  A normal user.
ulSpecialUser  A special user.
ulNightLockOnlyUser  A user that can only enter at night.
ulUnlockMaster  An unlock master.
ulKeypadProgrammer  A keypad programmer user.
ulNightLockMaster  A nightlock master user.
ulAddMaster  An add master.
ulVoidMaster  A void master.
ulProgramMaster  A programmaster user, can also be used as user programmer! Mapped internally to EUserLevel_USERPROGRAMMER.
ulInstallerProgrammer  An installer programmer user.
ulUserProgrammer  A user programmer user (NOT a real level!).

enum TalosAPILib::ECardType
 

Enumeration for the different ECardTypes used in the reader.

Enumeration values:
ctCrossPoint  Normal Cross Point ID cards.
ctHID_H10301_26  HID H10302 26.
ctHID_H10306_34  HID H10306 34.
ctHID_Corporate1000  HID Corporate 1000.
ctHID_H10302_37  HID H10302 37.
ctHID_H10304_37  HID H10304 37.
ctMifareStandard  Mifare standard.
ctEMMarin  EM_Marin standard (13 digits).

enum TalosAPILib::ERFIDMode
 

Defined RFID modes.

Enumeration values:
rmDisabled  Disable the RF/ID interface.
rmReceive  Receive mode.
rmTransmitExtClock  Transmit external clock mode.
rmTransmitIntClock  Transmit internal clock mode.

enum TalosAPILib::ELoggingMode
 

Specifies the logging modes.

Enumeration values:
lmDisabled  Logging disabled.
lmAlways  Always log.
lmDynamic  Log in dynamic switch mode.
lmUnknown  Logging mode is unknown.

enum TalosAPILib::ELoggingOptions
 

Specifies the categories that should be logged.

Enumeration values:
loUnknown  Unknown.
loSecurity  Log security events.
loLogConfig  Log configuration events.
loLogStatus  Log status events.
loUser  Log user events.
loDestructiveRead  Remove the events from the event database after they are read.
loAll  All options on.

enum TalosAPILib::EBaudrate
 

Specifies communication baudrate.

Enumeration values:
br9600  9600
br19200  19K2
br38400  38K4
br57600  Not fully supported (yet)!
br115200  Not fully supported (yet)!

enum TalosAPILib::EWeekScheme
 

Time zone week scheme.

Enumeration values:
wsUnknown  for error situations
wsSunday  Sunday.
wsMonday  Monday.
wsTuesday  Tuesday.
wsWednesday  Wednesday.
wsThursday  Thursday.
wsFriday  Friday.
wsSaturday  Saturday.
wsAlways  Always (all days).

enum TalosAPILib::ELockType
 

Enumeration for the door lock type.

Enumeration values:
ltNormallyOpen  Normally Open.
ltNormallyClosed  Normally Closed.
ltCodedSignal  Coded signal.

enum TalosAPILib::EEventDataType
 

The different event data types.

Enumeration values:
edNone  None (no data available).
edUser  An user.
edSystemParameter  A system area parameter number.
edParameter  A application parameter number (ENVP).
edUserLevel  A user level (EUserLevel).
edClock  Real time clock data (seconds since 1-1-2000).
edTestNumber  A test number.
edErrorNumber  An error number.
edUserGroupID  A user group ID.
edTimeSchemeID  A time scheme ID.

enum TalosAPILib::EEventClass
 

The different event data classes.

Enumeration values:
ecSecurity  Security class.
ecConfiguration  Configuration class.
ecStatus  Status class.
ecUserDefined  User defined class.
ecUnknown  Unknown class.

enum TalosAPILib::EOperationalMode
 

Enumeration for different reader operational modes.

Enumeration values:
omStartUp  Startup mode.
omSleep  Sleep mode.
omAccess  Access mode.
omNightLock  Night lock mode.
omAdd  Add mode.
omVoid  Void mode.
omProgram  Program mode.
omNetwork  Network mode.
omDemo  Demo mode.
omRQD  RQD mode.
omCount  Count mode.
omSelfTest  Selftest mode.
omCopy  Copy mode.
omKeyPad  Key pad mode.
omWiegand  Wiegand mode.
omMagStripe  Magstripe mode.
omSID  SID mode.

enum TalosAPILib::ESoftwareConfiguration
 

Enumeration for different reader software configurations.

Enumeration values:
scDefault  Default configuration.
scBasic  Basic configuration.
scAdvanced  Advanced configuration.
scStandAlone  Stand alone configuration.
scUnknown  Unknown configuration.

enum TalosAPILib::ESoftwareMode
 

Enumeration for different reader software modes.

Enumeration values:
smNone  Nonw.
smUnknown  Unknown software mode.
smBootloader  Bootloader mode.
smApplication  Application mode.
smNoReaderFound  Special case: No reader found.

enum TalosAPILib::ENVP
 

Enumeration for all NVPs. For a more detailed description: see the master manual.

Enumeration values:
nvpFirst  First NVP.
nvpSerialNumber  Serial number.
nvpHardwareVersion  Hardware version.
nvpExtensionBoardType  Extension board type.
nvpExtensionBoardVersion  Extension board version.
nvpBootloaderVersion  Bootloader version.
nvpOSVersion  OS (operating system) version.
nvpApplicationVersion  CPA (application) version.
nvpSoftwareConfiguration  Software configuration.
nvpSoftwareConfigurationKey  Software configuration key.
nvpNetworkAddress  Network address.
nvpOperationalMode  Operational mode.
nvpLevel  Level (0*).
nvpLockType  Lock type (23*).
nvpDoorOpenTime  Door open time (11*).
nvpDoorCloseTime  Door close time (12*).
nvpInactivityTime  Inactivity time (17*).
nvpUserOptions  User options (10*).
nvpInstallerOptions  Installer options (20*).
nvpSystemOptions  System options (25*).
nvpNetworkPollTime  Network poll time (22*).
nvpKeypadOptions  Key pad options (31*).
nvpAlarmCode  Alarm code (18*2*).
nvpAccessCode  Access code (18*1*).
nvpChangeCode  Change code (18*0*).
nvpUserLevelPassword  User level password (19*).
nvpInstallerLevelPassword  Installer level password (24*).
nvpEventLogMode  Event log mode (33*).
nvpEventLogOptions  Event log options (34*).
nvpUnlockzoneUnlockToLockMarker  Unlock zones unlock-to-lock marker (55*).
nvpUnlockzoneLockToUnlockMarker  Unlock zones lock-to-unlock marker (55*).
nvpUnlockzoneWeekscheme  Unlock zones week scheme (56*).
nvpPrinterEnable  Printer Enable (36*).
nvpAntiPassbackMode  Anti-passback mode (48*).
nvpAntiPassbackTime  Anti-passback time (49*).
nvpTimezoneNightToDayMarker  Time zones night-to-day marker (53*).
nvpTimezoneDayToNightMarker  Time zones day-to-night marker (53*).
nvpTimezoneWeekscheme  Time zones week scheme (54*).
nvpDeviceName  Name of the reader (52*).
nvpCurrentFileSystem  File system configuration (26*).
nvpMagstripeOutputFormat  Magstripe output format (44*).
nvpMagstripeOutputOptions  Magstripe output options (45*).
nvpMagstripeStartBits  Magstripe number of start bits (46*).
nvpMagstripeStopBits  Magstripe number of stop bits (47*).
nvpWiegandOutputFormat  Wiegand output format (42*).
nvpWiegandOutputOptions  Wiegand output options (43*).
nvpBaudrate  The baudrate of this reader.
nvpCharacterFrame  The character frame of this reader.
nvpDefaultUserGroup  The default user group of this reader.
nvpCardReadOptions  Card read options.
nvpLast  Last NVP (add some to allow new ones to be added pn the fly).
nvpUnknown  Unknown.

enum TalosAPILib::ENVPType
 

Enumeration for the different NVP data types.

Enumeration values:
ntUnsignedNumber  An unsigned number.
ntBitflags  A set of bit flags.
ntString  A string.
ntUnknown  Unknown type.

enum TalosAPILib::EAsyncMode
 

Enumeration for the different synchronization modes.

Enumeration values:
amDefault  Default: Use the API defaults.
amSync  Always send sync.
amAsync  Always send message asyn.

enum TalosAPILib::EFileType
 

Enumeration for the different output/input file types.

Enumeration values:
ftUnknown  Default: Use the API defaults.
ftXML  XML.
ftCSV  Comma separated file.
ftSimpleData  Simple data, not extended (parameterdatabase: do NOT include system parameters).
ftHTML  HTML file.

enum TalosAPILib::EUserConfiguration
 

Enumeration for the user database configuration.

Enumeration values:
ucUnknown  Unknown configuration.
ucID  If set, the user ID field is present in the userdatabase.
ucPincode  If set, the user Pincode field is present in the userdatabase.
ucName  If set, the user name field is present in the userdatabase.
ucValidPeriod  If set, the user validation times are present in the userdatabase.
ucUserGroups  If set, the user validation times are present in the userdatabase.

enum TalosAPILib::EVersionType
 

Enumeration for the GetVersion method, to able the GetVersion method to return different versions.

Enumeration values:
vtHardware  Hardware version.
vtBootloader  Bootloader version.
vtOS  OS version.
vtApplication  Application version.
vtExtensionBoard  Version of the current extension board.
vtFirmware  Firmware version (for firmware > 1.60, same as OSVersion).

enum TalosAPILib::EExtensionBoardType
 

Enumeration for the extension board type.

Enumeration values:
etNone  No extension board present.
etMifare  Mifare extension board type.
etHID  Mifare extension board type.
etLongRange  Long range extension board type.

enum TalosAPILib::EUploadOptions
 

Enumeration for the different upload types.

enum TalosAPILib::EFlashArea
 

Defined flash areas.

Enumeration values:
faUnknown  Unknown.
faOS  The OS flash area.
faApplication  The CPA flash area.
faFirmware  The OS and CPA flash area.

enum TalosAPILib::EMemoryType
 

Enumeration for different reader memory types.

Enumeration values:
mtUnknown  Unknown memory type.
mtProcessor  Processor memory.
mtSerialEEPROM  Serial EEPROM memory.
mtFlash  Flash memory.

enum TalosAPILib::ELEDState
 

Enumeration for different state of the LEDs on the reader.

Enumeration values:
lsNone  No LEDS.
lsYellow  The yellow led.
lsGreen  The green led.
lsRed1  The first red led.
lsRed2  The second red led.
lsRed3  The third red led.
lsRed4  The fourth red led.
lsRed5  The fifth red led.
lsAll  Light all leds.

enum TalosAPILib::EIOContacts
 

Enumeration for different IO contacts on the reader.

Enumeration values:
ioNone  Deactive all IO outputs.
io1  Activate IO contact 1.
io2  Activate IO contact 2.
io3  Activate IO contact 3.
io4  Activate IO contact 4.
ioAll  Activate all IO contacts.

enum TalosAPILib::EBuzzerState
 

Enumeration for the different buzzer states (sounds).

Enumeration values:
bzNoSound  No sound.
bzShortBeep  5500 Hz, 60 ms
bzMediumBeep  5500 Hz, 250 ms
bzLongBeep  5500 Hz, 500 ms
bzVeryLongBeep  5500 Hz, 2000 ms
bzContinuosly  Continuously 5500 Hz.
bzErrorBeep  3 Short beeps + 1 beep of 100 ms, 50 ms in between

enum TalosAPILib::ECopyFlags
 

Enumeration for the CopyFrom method.

Enumeration values:
cfNone  Copy nothing.
cfUsers  Copy the users.
cfParameters  Copy the parameters.
cfHolidays  Copy the holidays.
cfFileSystem  Reset the filesystem.
cfClearUsers  Clear existing users (if cfFileSystem is set all users will always be deleted).
cfAll  Copy all settings.

enum TalosAPILib::EProcessType
 

Enumeration for the status of a process. Used when firing events.

Enumeration values:
ptNone  No process, used internally.
ptApplicationChange  The network collection of this application has changed (an item was added/removed/modified).
ptNetworkChange  The reader collection of this network has changed (an item was added/removed/modified).
ptUserdatabaseChange  The userdatabase has changed (an item was added/removed/modified).
ptEventdatabaseChange  The userdatabase has changed (an item was added/removed/modified).
ptParameterdatabaseChange  The parameterdatabase has changed (an item was added/removed/modified).
ptFindingNetwork  Finding a single network.
ptScanningNetworks  Collecting all networks.
ptArchivingEvents  Archiving all events.
ptFindingReader  Finding a single reader.
ptScanningReaders  Collecting a range of addresses for readers.
ptChangingNetworkSettings  Network settings of a specific network have changed.
ptCheckingReaderPresence  Checking if a reader is present at a certain address.
ptSettingFileSystem  The SetFileSystem method of the ProximityReader object.
ptResetting  The reader is being resetted.
ptUpgradeSWConfiguration  The software configuration of the reader is being upgraded.
ptCopyingReader  The CopyFrom method of the ProximityReader object.
ptCollectingHolidays  The get_Holidays method of the ProximityReader object.
ptAddingHolidays  The AddHoliday method of the ProximityReader object.
ptChangingNetworkAddress  The networkaddress of the reader is being changed.
ptCopyFrom  Copying settings from another reader.
ptRemovingHolidays  Currently removing all holidays from the reader.
ptCollectingTimeSchemes  The get_TimeSchemes method of the ProximityReader object.
ptUploading  Uploading data from a file into a reader, userdatabase and/or parameters.
ptCollectingUsers  Collecting users (filling the userdatabase).
ptClearingUsers  Clearing the userdatabase.
ptSearchingUsers  Currently searching users.
ptSettingUsers  Setting users.
ptCollectingUserGroups  Collecting usergroups (filling the userdatabase).
ptRemovingExpiredUsers  Removing all expired users from the userdatabase.
ptCollectingEvents  Collecting events (filling the eventdatabase).
ptClearingEvents  Clearing the eventdatabase.
ptSearchingEvents  Currently searching events.
ptUploadingFirmware  Uploading new firmware.
ptErasingFirmware  Erasing a specific flash area.
ptWritingMemory  Writing new data into the reader's memory.
ptUploadingOS  Uploading the OS firmware.
ptUploadingCPA  Uploading the CPA firmware.
ptCollectingParameters  Collecting parameters (filling the parameterdatabase).
ptSettingParameters  Setting parameters.
ptParameterSaved  A parameter is saved.
ptSearching  Searching (both for the application and the proximityreader).
ptCollectingTimeBlocks  The get_TimeBlocks method of the ITimeScheme object.

enum TalosAPILib::ESubProcessType
 

Enumeration for the sub process type of a OnProcessInfo event.

Enumeration values:
sptProgress  The Info parameter contains progress information (percentage).
sptItemAdded  A new object has been added (the Info parameter holds the added object).
sptItemRemoved  An existing object has been removed (the Info parameter holds the removed object).
sptItemModified  An existing object has been modified (the Info parameter holds the modified object).
sptItemFound  A new object has been found, only used during a search process (the Info parameter holds the found object).
sptItemFailed  The object failed (the Info parameter holds the failed object).
sptCleared  All items have been removed (the Info parameter does not contain valid data).
sptItemMask  Mask to filter out the item related info.
sptFindingNetwork  Finding a single network.
sptSettingFileSystem  The SetFileSystem method of the ProximityReader object.
sptResetting  The reader is being resetted.
sptCollectingHolidays  The get_Holidays method of the ProximityReader object.
sptAddingHolidays  The AddHoliday method of the ProximityReader object.
sptRemovingHolidays  Currently removing all holidays from the reader.
sptCollectingUsers  Collecting users (filling the userdatabase).
sptClearingUsers  Clearing the userdatabase.
sptSearchingUsers  Currently searching users.
sptSettingUsers  Setting users.
sptSearchingEvents  Currently searching events.
sptErasingFirmware  Erasing a specific flash area.
sptUploadingOS  Uploading the OS firmware.
sptUploadingCPA  Uploading the CPA firmware.
sptCollectingParameters  Collecting parameters (filling the parameterdatabase).
sptSettingParameters  Setting parameters.
sptSubProcessMask  Mask to filter out the sub process.
sptInfo  The Info of a sub process.
sptStarted  Start of a sub process.
sptFinished  End of a sub process.
sptStatusMask  Mask to filter out the status (i.e. started, finished).

enum TalosAPILib::EProgressType
 

Enumeration for the ProximityReader's Progress event.

Enumeration values:
ptUnknown  Unknown progress.

enum TalosAPILib::ECollectingStatus
 

Enumeration for the status of a collecting process.

Enumeration values:
csUnknown  Unknown status.
csNotCollected  Not collected.
csBusy  Busy collecting.
csCollected  Collecting is finished.
csReady  Same as collected.

enum TalosAPILib::ESearchFlags
 

Enumeration for the different search flags.

Enumeration values:
sfNone  Unknown status.
sfSearchAsync  Perform the search asynchronously.
sfSearchAllReaders  Perform the search in all readers (only useful asynchronously).
sfUsers  Search in the user database.
sfEvents  Search in the event database.
sfClearResults  If set, the previous search results will be cleared automatically.
sfSearchResults2  If set, the search results will be stored in a second internal buffer.

enum TalosAPILib::ESearchStatus
 

Enumeration for the status of search processes.

Enumeration values:
ssUnknown  Unknown status.
ssNoSearchResults  No search results present.
ssSearchingUsers  Busy searching.
ssSearchingEvents  Busy searching.
ssBusy  The reader is busy searching (ssSearchingUsers + ssSearchingEvents).
ssReadersBusy  One or more readers are still busy searching.
ssUsersSearched  Finished searching users.
ssEventsSearched  Finished searching events.
ssSearched  Finished searching.
ssReady  Same as ssSearched.

enum TalosAPILib::EUserGroupFlags
 

Enumeration for the different flags of a usergroup.

Enumeration values:
ugfNone  No special flags specified.
ugfOverruleHolidays  This usergroup overrules holidays.

enum TalosAPILib::ETimeSchemeDay
 

Time scheme day numbers.

Enumeration values:
tsdSunday  Sunday.
tsdMonday  Monday.
tsdTuesday  Tuesday.
tsdWednesday  Wednesday.
tsdThursday  Thursday.
tsdFriday  Friday.
tsdSaturday  Saturday.
tsdUnknown  Unknown day.

enum TalosAPILib::EArchiveEventsOptions
 

Options for the archive events method.

Enumeration values:
aeoAllEvents  Archive all events.
aeoSecurityEventsOnly  Archive only security events.


© Copyright 2001 - 2006 Cross Point. Generated on Mon Mar 12 16:29:52 2007 Cross Point