Cross Point


IEvent Interface Reference

Inheritance diagram for IEvent:

IXMLBase IEventBase List of all members.

Detailed Description

This interface represents a single event.

This object is used in the IEventDatabase interface, it encapsulates event information. This simplifies passing event information to and from the event database.

It is further used when searching the event database for specific information.


Public Member Functions

HRESULT EventDatabase ([out, retval] IEventDatabase **ppintfEventDatabase)
 Returns the event database this event belongs to.

HRESULT ID ([out, retval] long *plEventID)
 Returns the event ID for this Event.

HRESULT Date ([out, retval] DATE *pDate)
 Returns the date of this Event.

HRESULT Class ([out, retval] EEventClass *peClass)
 Returns the class of this Event.

HRESULT DataType ([out, retval] EEventDataType *peDatatype)
 Returns the data type of this Event.

HRESULT Data ([out, retval] VARIANT *pvtData)
 Returns the data of this Event.

HRESULT ExtraData ([out, retval] VARIANT *pvtExtraData)
 Returns the extra data for this Event.

HRESULT Description ([out, retval] BSTR *pbstrDescription)
 Returns a description of this event (only if a correct language dll can be found).

HRESULT GetDescription ([in] VARIANT_BOOL WithHTML,[out, retval] BSTR *pbstrDescription)
 Returns a description of this event.

HRESULT User ([out, retval] IUser **ppintfUser)
 Returns the user object that caused this event.

HRESULT Parameter ([out, retval] IParameter **ppintfParameter)
 Returns the parameter that caused this event.


Member Function Documentation

IEvent::EventDatabase [out, retval] IEventDatabase **  ppintfEventDatabase  ) 
 

Returns the event database this event belongs to.

Parameters:
ppintfEventDatabase Receives the event database object.
Precondition:
ppintfEventDatabase is not NULL .
Note:
This is a read-only property when used in scripting languages.
See also:
IEventDatabase

IEvent::ID [out, retval] long *  plEventID  ) 
 

Returns the event ID for this Event.

The event ID is not a unique ID but rather a event type. The access granted event is event ID 0, Access denied is ID 1 etc.

Parameters:
plEventID A pointer to a long that receives the Event ID of this event.
Precondition:
plEventID is not NULL.
Note:
This is a read-only property when used in scripting languages.

IEvent::Date [out, retval] DATE *  pDate  ) 
 

Returns the date of this Event.

Returns the time-stamp of this event. Note that the internal clock of the reader is reset to the time of the last entry in the event-log of the reader (if it has one) every time it is reset!

So when resetting the reader very often, the date returned by this method might not be the actual time. This time is not acurate enough for for instance time & attendance systems or salary systems!

Parameters:
pDate Receives the current date of this event.
Precondition:
pDate is not NULL.
Note:
This is a read-only property when used in scripting languages.

IEvent::Class [out, retval] EEventClass peClass  ) 
 

Returns the class of this Event.

There are currently 3 different event classes, security events, configuration events and status events. Logging of events can be enabled/disabled on a event class basis.

Parameters:
peClass Receives the EEventClass enumeration of current class.
Precondition:
peClass is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
EEventClass

IEvent::DataType [out, retval] EEventDataType pEEventDataType  ) 
 

Returns the data type of this Event.

Parameters:
pEEventDataType The current data type of type EEventDataType.
Precondition:
pEEventDataType is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
EEventDataType

IEvent::Data [out, retval] VARIANT *  pvtData  ) 
 

Returns the data of this Event.

The returned data may vary:

  • For user events (edUser), the user ID is returned here as a string.
  • For parameter and systemparameters events (edSystemParameter or edParameter), the parameter number is returned here.
  • For user level event (edUserLevel), the new user level is returned here (0 or 1).
  • For time events (edClock), the date-time contained in this event is returned as a date.
  • For test events (edTestNumber) the number of the test is returned.
  • For user group events (edUserGroupID) the ID of the user group is returned.
  • For time scheme events (edTimeSchemeID) the ID of the time scheme is returned.
Parameters:
pvtData Returns the data.
Precondition:
pvtData is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
ExtraData

IEvent::ExtraData [out, retval] VARIANT *  pvtExtraData  ) 
 

Returns the extra data for this Event.

If this event is a user event (edUser), the extra data will contain the cardtype. If this event contains a parameter event (edSystemParameter or edParameter), the extra data will be set to the new parameter value.

Parameters:
pvtExtraData Receive the data.
Precondition:
pvtExtraData is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
Data

IEvent::Description [out, retval] BSTR *  pbstrDescription  ) 
 

Returns a description of this event (only if a correct language dll can be found).

Simply calls GetDescription with the fHTML argument set to false.

Parameters:
pbstrDescription Returns the description of this event.
pbstrDescription is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
GetDescription

IEvent::GetDescription [in] VARIANT_BOOL  fHTML,
[out, retval] BSTR *  pbstrDescription
 

Returns a description of this event.

Returns a description of this event. The fHTML flag only has effect for the access-denied event, the card number will then contain a hyperlink to includes all data of this event.

Some examples:

  • If this event is an access-denied event, the long english description will return: "Access was denied to a user that owns a card with cardnumber 123123."
  • For an parameter changed event: "Application parameter 'Unlock, week scheme' is changed to 'Monday, Tuesday'.
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.

Parameters:
fHTML If set to true, a HTML tag will be included for user data and parameters.
pbstrDescription Receives the description of this event.
pbstrDescription is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
Description

IEvent::User [out, retval] IUser **  ppintfUser  ) 
 

Returns the user object that caused this event.

Returns a user object containing all user data that caused this event. Only works for events that contain user data (whose DataType is edUser). The user object that is returned here, can be used for instance to add an unknown card/user to the reader (when this is an access denied event for instance).

Parameters:
ppintfUser Receives the user object.
Note:
Only returns a user object if the DataType is edUser, else it returns no object!

This is a read-only property when used in scripting languages.

See also:
IUser, DataType

IEvent::Parameter [out, retval] IParameter **  ppintfParameter  ) 
 

Returns the parameter that caused this event.

Returns a parameter object containing all parameter info stored in this event. Only works for parameter events (when the DataType is edParameter). The returned parameter object will be a read-only object, the parameter can never be saved!

Parameters:
ppintfParameter Receives a pointer to the parameter object that caused this event.
Note:
Only returns a parameter object if the DataType is edParameter, else it returns no object.

Returns a read-only parameter object.

This is a read-only property when used in scripting languages.

See also:
IParameter


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