Inheritance diagram for IUserGroup:
User groups are only supported with firmware newer then 1.63 and a file system 16 or 17.
This object is used in the IUserDatabase interface, it encapsulates user group information such as the ID, flags and description. Every user group is linked to a single time scheme. A user can only be a member of a single user group (see IUser::UserGroupID).
When the ugfOverruleHolidays flag is set for a user group, the user group will overrule holidays, meaning that even if the current day is a holiday, the access times as specified in the time scheme will be used. If this flag is not specified, and today is a holiday, the time scheme will not be used, and access is denied to all users of this user group.
Users that are added using a remote programmer / master cards, will automatically become a member of the default user group. The default user group can be set using the nvpDefaultUserGroup parameter.
This interface simplifies passing usergroup information to and from the reader. A reader can contain a maximum of 16 user groups.
Public Member Functions | |
HRESULT | UserDatabase ([out, retval] IUserDatabase **ppintfUserDatabase) |
Returns the userdatabase this usergroup belongs to. | |
HRESULT | ID ([out, retval] long *plID) |
Returns the ID of this usergroup. | |
HRESULT | Description ([out, retval] BSTR *bstrDescription) |
Returns the description of this usergroup. | |
HRESULT | Description ([in] BSTR Description) |
Sets a description for this usergroup. | |
HRESULT | Flags ([out, retval] EUserGroupFlags *peFlags) |
Returns the flags of this usergroup. | |
HRESULT | Flags ([in] EUserGroupFlags Flags) |
Sets the new flags for this usergroup. | |
HRESULT | TimeSchemeID ([out, retval] long *plTimeSchemeID) |
Returns the ID of the time scheme linked to this user group. | |
HRESULT | TimeSchemeID ([in] long lTimeSchemeID) |
Sets the new ID of the time scheme that should be linked to this usergroup. | |
HRESULT | TimeScheme ([out, retval] ITimeScheme **ppintfTimeScheme) |
Returns the time scheme that is linked to this user group. | |
HRESULT | TimeScheme ([in] ITimeScheme *pintfTimeScheme) |
Sets the new time scheme that should be linked to this usergroup. | |
HRESULT | Users ([out, retval] ICollection **ppintfUsers) |
Returns a collection of all users in this usergroup. | |
HRESULT | Save ([out, retval] VARIANT_BOOL *pfSucceeded) |
Stores this usergroup information in the reader. |
|
Returns the userdatabase this usergroup belongs to.
|
|
Returns the ID of this usergroup.
|
|
Returns the description of this usergroup.
|
|
Sets a description for this usergroup.
|
|
Returns the flags of this usergroup.
|
|
Sets the new flags for this usergroup. There is currently only a single flag: \ li ugfOverruleHolidays When the ugfOverruleHolidays flag is set for a user group, the user group will overrule holidays, meaning that even if the current day is a holiday, the access times as specified in the time scheme will be used. If this flag is not specified, and today is a holiday, the time scheme will not be used, and access is denied to all users of this user group.
|
|
Returns the ID of the time scheme linked to this user group.
|
|
Sets the new ID of the time scheme that should be linked to this usergroup.
|
|
Returns the time scheme that is linked to this user group.
|
|
Sets the new time scheme that should be linked to this usergroup.
|
|
Returns a collection of all users in this usergroup. If the IUserDatabase::CollectUsers method is not yet called, this property will fail. So please call the IUserDatabase::CollectUsers method first before calling this property.
|
|
Stores this usergroup information in the reader. The usergroup will only be saved when the data of this usergroup has changed.
|