Cross Point


IAccessControl Interface Reference

List of all members.

Detailed Description

This interface groups all functionality needed to set access control parameters of the reader.

An additional method is added that enables a programmer to open the door remotely, the OpenDoor method.

To fine grade access control to a building, several settings are important, like anti-passback to be sure that an access card cannot be used by different persons walking behind each other.

Also, it can be very useful to allow some group of users only access at night, and other groups only by day. This night-lock scheme needs a lot of parameters to fine-grade its behavior. The night-lock feature however will not work when the reader is in user-group mode (with firmware > 1.63 and when its file system is set to 16 or 17). The user group / time scheme settings will override the night-lock mode settings.

Another feature of this interface is the unlock feature. Using this feature time schemes can be configured in which the door will always unlocked. This can be a useful feature for internal office doors, the door will remain open between office hours, but outside office hours, employees require a card to access certain areas.

All these parameters can be set with the methods in this interface. Below a detailed description of all members is shown.

Note that all these settings contained in this interface can also be changed by changing the appropriate parameter in the parameter database. But that will require more detailed knowledge about the different parameter values, it is more convenient to use this interface.


Public Member Functions

HRESULT Reader ([out, retval] IProximityReader **ppintfReader)
 Returns the reader this access control object belongs to.

HRESULT OperationalMode ([out, retval] EOperationalMode *peMode)
 Returns the current operational mode of the attached reader.

HRESULT AntiPassbackMode ([out, retval] VARIANT_BOOL *pfStatus)
 Returns the current state of the anti-passback mode.

HRESULT AntiPassbackMode ([in] VARIANT_BOOL fStatus)
 Sets the anti-passback mode.

HRESULT AntiPassbackTime ([out, retval] short *psSeconds)
 Returns the number of seconds that is used as anti-passback time.

HRESULT AntiPassbackTime ([in] short sSeconds)
 Sets the number of seconds that is used as anti-passback time.

HRESULT DayToNightTime ([out, retval] DATE *pdate)
 Returns the time when the reader switches from day to night.

HRESULT DayToNightTime ([in] DATE date)
 Sets the timezone day-to-night time.

HRESULT NightToDayTime ([out, retval] DATE *pdate)
 Returns the timezone night-to-day time.

HRESULT NightToDayTime ([in] DATE date)
 Sets the timezone night-to-day time.

HRESULT TimezoneWeekScheme ([out, retval] EWeekScheme *peScheme)
 Returns the days (or-ed together) on which the timezones are active.

HRESULT TimezoneWeekScheme ([in] EWeekScheme eScheme)
 Sets the days that are configured to use with the timezones.

HRESULT UnlockToLockTime ([out, retval] DATE *pdate)
 Returns the time when the reader switches from unlock to lock mode.

HRESULT UnlockToLockTime ([in] DATE date)
 Sets the unlockzone unlock-to-lock time.

HRESULT LockToUnlockTime ([out, retval] DATE *pdate)
 Returns the unlockzone lock-to-unlock time.

HRESULT LockToUnlockTime ([in] DATE date)
 Sets the unlockzone lock-to-unlock time.

HRESULT UnlockzoneWeekScheme ([out, retval] EWeekScheme *peScheme)
 Returns the days (or-ed together) on which the unlockzones are active.

HRESULT UnlockzoneWeekScheme ([in] EWeekScheme eScheme)
 Sets the days on which the unlock zones should be active.

HRESULT DoorOpenTime ([out, retval] short *psSeconds)
 Returns the number of seconds that a door remains open after access was granted.

HRESULT DoorOpenTime ([in] short sSeconds)
 Sets the number of seconds that a door remains open after access was granted.

HRESULT DoorCloseTime ([out, retval] short *psSeconds)
 Returns the number of seconds that a door should remain closed before granting access again.

HRESULT DoorCloseTime ([in] short sSeconds)
 Sets the number of seconds that a door should remain closed until access is granted again.

HRESULT LockType ([out, retval] ELockType *peLockType)
 Returns the type of lock that is used by the reader.

HRESULT LockType ([in] ELockType eLockType)
 Sets the type of lock that should be used by the reader.

HRESULT OpenDoor ()
 Open the door.


Member Function Documentation

IAccessControl::Reader [out, retval] IProximityReader **  ppintfReader  ) 
 

Returns the reader this access control object belongs to.

Parameters:
ppintfReader Receives the reader object.
Precondition:
ppintfReader is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
IProximityReader

IAccessControl::OperationalMode [out, retval] EOperationalMode peMode  ) 
 

Returns the current operational mode of the attached reader.

This method returns the current operational mode of the reader.

Parameters:
peMode Receives the current operational mode of the reader.
Precondition:
peMode is not NULL.
Note:
This is a read-only property when used in scripting languages. This is the default property of this object.
See also:
EOperationalMode

IAccessControl::AntiPassbackMode [out, retval] VARIANT_BOOL *  pfMode  ) 
 

Returns the current state of the anti-passback mode.

Anti passback mode enables the reader to determine if a card is used twice (a person passes his card back to another user) within a specified time. If the anti passback mode is turned on, the reader will notice this and will deny access to the second user.

Parameters:
pfMode Receives the current state of the anti-passback option (true if enabled).
Precondition:
pfMode is not NULL.
See also:
AntiPassbackTime

IAccessControl::AntiPassbackMode [in] VARIANT_BOOL  fMode  ) 
 

Sets the anti-passback mode.

Anti passback mode enables the reader to determine if a card is used twice (a person passes his card back to another user) within a specified time. If the anti passback mode is turned on, the reader will notice this and will deny access to the second user.

Parameters:
fMode When set to VARIANT_TRUE, anti-passback will be enabled.
See also:
AntiPassbackTime

IAccessControl::AntiPassbackTime [out, retval] short *  psSeconds  ) 
 

Returns the number of seconds that is used as anti-passback time.

This time specifies how long a card cannot be used after access was granted. This property returns the time in seconds that is used as anti-passback time. After a user is granted access with a card, that card cannot be used for the time returned by this property.

Parameters:
psSeconds Receives the anti-passback time in seconds.
Precondition:
psSeconds is not NULL.
See also:
AntiPassbackMode

IAccessControl::AntiPassbackTime [in] short  sSeconds  ) 
 

Sets the number of seconds that is used as anti-passback time.

This time specifies how long a card cannot be used after access was granted. With this property the time in seconds that is used as anti-passback can be set. After a user is granted access with a card, that card cannot be used for the time set using this property.

Parameters:
sSeconds The new number of seconds used as anti-passback time.
See also:
AntiPassbackMode

IAccessControl::DayToNightTime [out, retval] DATE *  pdate  ) 
 

Returns the time when the reader switches from day to night.

This property returns the time when the reader switches from day to night (switches to nightlock mode). Only the time-part of the DATE is used.

Parameters:
pdate Will be set to the current day-to-night time.
Note:
The day-part of the date should be ignored.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
NightToDayTime, TimezoneWeekScheme

IAccessControl::DayToNightTime [in] DATE  date  ) 
 

Sets the timezone day-to-night time.

This property sets the time when the reader switches from day to night (switches to nightlock mode).

Parameters:
date The new time when the day-to-night change should occur.
Note:
Only the time-part of the DATE is used, the day-part is ignored.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
NightToDayTime, TimezoneWeekScheme

IAccessControl::NightToDayTime [out, retval] DATE *  pdate  ) 
 

Returns the timezone night-to-day time.

This property returns the time when the reader switches from night to day (switches from nightlock mode into normal access mode). Only the time-part of the DATE is used.

Parameters:
pdate The time of the night-to-day change.
Precondition:
pdate is not NULL.
Note:
The day-part of the date should be ignored.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
DayToNightTime, TimezoneWeekScheme

IAccessControl::NightToDayTime [in] DATE  date  ) 
 

Sets the timezone night-to-day time.

This property sets the time when the reader switches from night to day (switches from nightlock mode into normal access mode).

Parameters:
date The new time when the night-to-day should occur.
Note:
Only the time-part of the DATE is used, the day-part is ignored.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
DayToNightTime, TimezoneWeekScheme

IAccessControl::TimezoneWeekScheme [out, retval] EWeekScheme peScheme  ) 
 

Returns the days (or-ed together) on which the timezones are active.

Returns the days on which the timezones (day-to-night and night-to-day times) are active.

Parameters:
peScheme Receives the days on which the timezones feature is enabled.
Precondition:
peScheme is not NULL.
Note:
These values can be or-ed together (like wsSunday | wsSaturday).

On days on which timezones are not active, the reader will be in nightlock mode for the whole day.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
EWeekScheme, DayToNightTime, NightToDayTime

IAccessControl::TimezoneWeekScheme [in] EWeekScheme  eScheme  ) 
 

Sets the days that are configured to use with the timezones.

Sets the days on which the timezones (day-to-night and night-to-day times) should be active.

Parameters:
eScheme The new days on which the timezones feature should be enabled.
Note:
These values can be or-ed together (like wsSunday | wsSaturday).

On days on which timezones are not active, the reader will be in nightlock mode for the whole day.

Nightlock mode does not work with readers that are in usergroup/timescheme mode (firmware > 1.63 and file system 16 or 17).

See also:
EWeekScheme, DayToNightTime, NightToDayTime

IAccessControl::UnlockToLockTime [out, retval] DATE *  pdate  ) 
 

Returns the time when the reader switches from unlock to lock mode.

This property returns the time when the reader switches from unlock to lock mode. In unlock mode the door is always open. Lock mode is the normal reader mode where the door opens when a user presents a valid card. Only the time-part of the DATE is used.

Parameters:
pdate Will be set to the current unlock-to-lock time.
Note:
The day-part of the date should be ignored.
See also:
LockToUnlockTime, UnlockzoneWeekScheme

IAccessControl::UnlockToLockTime [in] DATE  date  ) 
 

Sets the unlockzone unlock-to-lock time.

Use this property to set the time when the reader should switch from unlock to lock mode.

Parameters:
date The new time of the unlock-to-lock change.
Note:
Only the time-part of the DATE is used, the day-part is ignored.
See also:
UnlockToLockTime, UnlockzoneWeekScheme

IAccessControl::LockToUnlockTime [out, retval] DATE *  pdate  ) 
 

Returns the unlockzone lock-to-unlock time.

This property returns the time when the reader switches from lock to unlock mode. Only the time-part of the DATE is used.

Parameters:
pdate The time of the lock-to-unlock change.
Precondition:
pdate is not NULL
See also:
UnlockToLockTime, UnlockzoneWeekScheme

IAccessControl::LockToUnlockTime [in] DATE  date  ) 
 

Sets the unlockzone lock-to-unlock time.

Use this property to set the time when the reader should switch from lock to unlock mode.

Parameters:
date The new time of the lock-to-unlock change.
Note:
Only the time-part of the DATE is used, the day-part is ignored.
See also:
UnlockToLockTime, UnlockzoneWeekScheme

IAccessControl::UnlockzoneWeekScheme [out, retval] EWeekScheme peScheme  ) 
 

Returns the days (or-ed together) on which the unlockzones are active.

Returns the days on which the unlock zones (as specified with the unlock-to-lock and lock-to-unlock times) are active.

Parameters:
peScheme Receives the days on which the unlockzones feature is enabled.
Precondition:
peScheme is not NULL.
Note:
These values can be or-ed together (like wsSunday | wsSaturday).

On days on which unlockzones are not active, the reader will be in lock mode (normal reader mode).

See also:
EWeekScheme, UnlockToLockTime, LockToUnlockTime

IAccessControl::UnlockzoneWeekScheme [in] EWeekScheme  eScheme  ) 
 

Sets the days on which the unlock zones should be active.

Use this property to set the days on which the unlockzones (as specified with unlock-to-lock and lock-to-unlock times) should be active.

Parameters:
eScheme The new days on which the unlockzones feature should be enabled.
Note:
These values can be or-ed together (like wsSunday | wsSaturday).

On days on which unlockzones are not active, the reader will be in lock mode (normal reader mode).

See also:
EWeekScheme, UnlockToLockTime, LockToUnlockTime

IAccessControl::DoorOpenTime [out, retval] short *  psSeconds  ) 
 

Returns the number of seconds that a door remains open after access was granted.

Parameters:
psSeconds The current number of seconds that the door remains open.
Precondition:
psSeconds is not NULL.
See also:
DoorCloseTime

IAccessControl::DoorOpenTime [in] short  sSeconds  ) 
 

Sets the number of seconds that a door remains open after access was granted.

Parameters:
sSeconds The new number of seconds that the door should remain open.
See also:
DoorCloseTime

IAccessControl::DoorCloseTime [out, retval] short *  psSeconds  ) 
 

Returns the number of seconds that a door should remain closed before granting access again.

Parameters:
psSeconds Receives the current number of seconds that the door should remain closed.
Precondition:
psSeconds is not NULL.
See also:
DoorOpenTime

IAccessControl::DoorCloseTime [in] short  sSeconds  ) 
 

Sets the number of seconds that a door should remain closed until access is granted again.

Parameters:
sSeconds The new number of seconds that the door should remain closed.
See also:
DoorOpenTime

IAccessControl::LockType [out, retval] ELockType peLockType  ) 
 

Returns the type of lock that is used by the reader.

Parameters:
peLockType Receives the currently used type of lock.
Precondition:
eLockType is not NULL.
See also:
ELockType

IAccessControl::LockType [in] ELockType  eLockType  ) 
 

Sets the type of lock that should be used by the reader.

Parameters:
eLockType The new type of lock that should be used.
See also:
ELockType

IAccessControl::OpenDoor  ) 
 

Open the door.

The door will automatically lock again after the specified door-open time has expired. An egress-event is logged (if the appropriate event logging option is enabled) to the readers internal event database when this method is called.

See also:
DoorOpenTime, DoorCloseTime


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