Inheritance diagram for IUser:
This object is used in the IUserDatabase interface, it encapsulates user information. This simplifies passing user information to and from the user database.
When this reader contains firmware newer then 1.63 and a filesystem of 16 or 17, the user groups, time schemes and validation period features are enabled. For more information regarding user groups and time schemes see IUserGroup and/or ITimeScheme.
Validation periods is a feature that a card is only valid between two specific dates. The card does not have access before the start date and has no access after the end date has passed. This feature is especially useful for visitor cards, or cards for hotel rooms, where a card is only allowed access on a certain day.
Public Member Functions | |
HRESULT | UserDatabase ([out, retval] IUserDatabase **ppintfUserDatabase) |
Returns the userdatabase this user belongs to. | |
HRESULT | Name ([out, retval] BSTR *pbstrName) |
Returns the name of this user. | |
HRESULT | Name ([in] BSTR bstrName) |
Sets the name of this user. | |
HRESULT | CardNumber ([out, retval] BSTR *pbstrCardNumber) |
Gets the card number of this user. | |
HRESULT | CardNumber ([in] BSTR bstrCardNumber) |
Sets the new card number for this user. | |
HRESULT | FacilityCode ([out, retval] BSTR *pbstrFacility) |
Returns the current facility code for this user. | |
HRESULT | FacilityCode ([in] BSTR bstrFacility) |
Sets the facility code for this user. | |
HRESULT | CardType ([out, retval] ECardType *peType) |
Returns the type of the card this user uses. | |
HRESULT | CardType ([in] ECardType eType) |
Sets the type of the card this user uses. | |
HRESULT | CardTypeDescription ([out, retval] BSTR *pbstrCardTypeDescription) |
Returns a description of the current cardtype of this user. | |
HRESULT | Level ([out, retval] EUserLevel *peLevel) |
Returns the user level of this user. | |
HRESULT | Level ([in] EUserLevel eLevel) |
Sets the level of this user. | |
HRESULT | LevelDescription ([out, retval] BSTR *pbstrLevelDescription) |
Returns a description of the level of this user. | |
HRESULT | ValidatePinCode ([in] long PinCode,[out, retval] VARIANT_BOOL *pfValid) |
Validate if a pincode matches with the pincode of this user. | |
HRESULT | SetPinCode ([in] long OldPinCode,[in] long NewPinCode,[out, retval] VARIANT_BOOL *pfSucceeded) |
Sets a new pincode for this user. | |
HRESULT | Save ([in, defaultvalue(0xffff)] VARIANT_BOOL fDisableRFID,[out, retval] VARIANT_BOOL *pfSucceeded) |
Stores the user data in the reader. | |
HRESULT | HasValidPeriod ([out, retval] VARIANT_BOOL *pfValidPeriod) |
Returns true if this user has a validation period. | |
HRESULT | StartDate ([out, retval] DATE *pdtStartDate) |
Returns the start of the valid period of this user. | |
HRESULT | EndDate ([out, retval] DATE *pdtEndDate) |
Returns the end of the valid period of this user. | |
HRESULT | SetValidPeriod ([in, defaultvalue(0)] DATE dtStartDate,[in, defaultvalue(0)] DATE dtEndDate) |
Set the valid period for this user. | |
HRESULT | UserGroup ([out, retval] IUserGroup **ppintfUserGroup) |
Returns this user's user group. | |
HRESULT | UserGroup ([in] IUserGroup *pintfUserGroup) |
Set the user group of this user. | |
HRESULT | UserGroupID ([out, retval] long *plID) |
Returns the ID of the user group of this user. | |
HRESULT | UserGroupID ([in] long lID) |
Set the new user group ID of this user. | |
HRESULT | NumberOfPinAttemptsLeft ([out, retval] short *psAttempts) |
Returns the number of pin attempts left for this user. | |
HRESULT | _ID64 ([out, retval] unsigned __int64 *piID) |
Returns the user ID as a 64 bit value. |
|
Returns the userdatabase this user belongs to.
|
|
Returns the name of this user.
|
|
Sets the name of this user.
|
|
Gets the card number of this user.
|
|
Sets the new card number for this user.
|
|
Returns the current facility code for this user.
|
|
Sets the facility code for this user.
|
|
Returns the type of the card this user uses.
|
|
Sets the type of the card this user uses.
|
|
Returns a description of the current cardtype of this user. When the current card type of the user is for instance ctCrossPoint, this property will return the string "Cross Point" on a english windows system. The description is loaded from the resource dll of the current selected windows language (if found), so when a Dutch windows version is installed, a dutch description will be returned.
|
|
Returns the user level of this user.
|
|
Sets the level of this user.
|
|
Returns a description of the level of this user. When the current level of a user is for instance ulInstallerProgrammer, this method will return the string "Installer programmer" on a english windows system. The description is loaded from a resource dll (only if the correct language dll can be found). Note that when for instance a Dutch windows version is installed, a dutch description will be returned.
|
|
Validate if a pincode matches with the pincode of this user. Returns true if lPinCode matches the current pincode of this user.
|
|
Sets a new pincode for this user. The PinCode may only be changed if the old pincode of this user is also passed to this method and if it matches the current pincode of this user.
|
|
Stores the user data in the reader. The user will only be saved when the data of this user is changed. When saving a lot of users after each other, it is faster to disable the RFID interface before saving the first user, and re-enable it after the last user has been saved (and setting the fDisableRFID flag to false). See IProximityReader::EnableRFID for more information. If a new user is saved (one that is not known in the userdatabase), the IUserDatabase will fire an OnProcessInfo event of processtype ptUserdatabaseChange with a sub process type of sptItemAdded. The new user will be passed in the Info argument. The new user object is also added to the user database internal collection of users. So calling the collection returned by IUserDatabase::Users will also contain the new user. If an existing user is modified, the same event is fire, but the sub process type will then be set to sptItemModified.
|
|
Returns true if this user has a validation period.
|
|
Returns the start of the valid period of this user. The user will not be granted access before the start date returned by this property. When the startdate is set to 0, the user will always have access (until the end-date occurs).
|
|
Returns the end of the valid period of this user. The user will not be granted access after the end date returned by this property. When the enddate is set to 0, the user will be have always access (after the start-date).
|
|
Set the valid period for this user.
|
|
Returns this user's user group. The user group is only returned if user groups are supported by the current firmware and filesystem of this reader, else an error is returned.
|
|
Set the user group of this user. If user groups are not supported by the current firmware and filesystem of this reader, an error is returned.
|
|
Returns the ID of the user group of this user. If user groups are not supported by the current firmware and filesystem of this reader, an error is returned.
|
|
Set the new user group ID of this user. If user groups are not supported by the current firmware and filesystem of this reader, an error is returned.
|
|
Returns the number of pin attempts left for this user. When this value is 0, the user is blocked. The pin code should then be reset before the user can use it's ID card again.
|
|
Returns the user ID as a 64 bit value.
|