Cross Point


ITimeBlock Interface Reference

Inheritance diagram for ITimeBlock:

IXMLBase IEventBase List of all members.

Detailed Description

This interface represents a time block.

A time block is a period in time in which users are allowed access (after presenting their card). Outside the time blocks, access is denied to the all users of this time scheme. The time schemes are weekly schedules, they consists of 7 days that can hold a maximum of 3 time blocks per day.

This object is used in the ITimeScheme interface, it encapsulates time block information such as the Index, Day, StartTime and EndTime.

This object simplifies passing time block information to and from a time scheme.


Public Member Functions

HRESULT TimeScheme ([out, retval] ITimeScheme **ppintfTimeScheme)
 Returns the time scheme of this time block.

HRESULT Index ([out, retval] long *plIndex)
 Returns the index of this time block in the current day.

HRESULT Index ([in] long lIndex)
 Set the index of this time block.

HRESULT Day ([out, retval] ETimeSchemeDay *peDay)
 Returns the day of this time block.

HRESULT Day ([in] ETimeSchemeDay eDay)
 Sets the new day of this time block.

HRESULT StartTime ([out, retval] long *pltTime)
 Returns the start time of this time block.

HRESULT StartTime ([in] long lTime)
 Sets the start time of this time block.

HRESULT EndTime ([out, retval] long *pltTime)
 Returns the end time of this time block.

HRESULT EndTime ([in] long lTime)
 Sets the end time of this time block.

HRESULT Save ([out, retval] VARIANT_BOOL *pfSucceeded)
 Stores this time block information in the reader.

HRESULT IsValid ([out, retval] VARIANT_BOOL *pfValid)
 Returns true if this time block is set.


Member Function Documentation

ITimeBlock::TimeScheme [out, retval] ITimeScheme **  ppintfTimeScheme  ) 
 

Returns the time scheme of this time block.

Parameters:
ppintfTimeScheme Receives the time scheme object.
Precondition:
ppintfTimeScheme is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
ITimeScheme

ITimeBlock::Index [out, retval] long *  plIndex  ) 
 

Returns the index of this time block in the current day.

Parameters:
plIndex Receives the index of this time block.
Precondition:
plIndex is not NULL.

ITimeBlock::Index [in] long  lIndex  ) 
 

Set the index of this time block.

Parameters:
lIndex The new index for this time block (0 - 2).

ITimeBlock::Day [out, retval] ETimeSchemeDay peDay  ) 
 

Returns the day of this time block.

Parameters:
peDay Receives the day of this time block.
Precondition:
peDay is not NULL.

ITimeBlock::Day [in] ETimeSchemeDay  eDay  ) 
 

Sets the new day of this time block.

Parameters:
eDay The new day of this time block.

ITimeBlock::StartTime [out, retval] long *  plTime  ) 
 

Returns the start time of this time block.

Parameters:
plTime Receives the start time of this time block.
Precondition:
plTime is not NULL.
Note:
The time is returned in minutes since midnight.

ITimeBlock::StartTime [in] long  lTime  ) 
 

Sets the start time of this time block.

Parameters:
lTime The new start time of this time block.
Note:
The time is in minutes since midnight. When set to -1, the start time is empty.

ITimeBlock::EndTime [out, retval] long *  plTime  ) 
 

Returns the end time of this time block.

Parameters:
plTime Receives the end time of this time block.
Precondition:
plTime is not NULL.
Note:
The time is returned in minutes since midnight.

ITimeBlock::EndTime [in] long  lTime  ) 
 

Sets the end time of this time block.

Parameters:
lTime The new end time of this time block.
Note:
The time is in minutes since midnight. When set to -1, the end time is empty.

ITimeBlock::Save [out, retval] VARIANT_BOOL *  pfSucceeded  ) 
 

Stores this time block information in the reader.

The time block will only be saved when the data of this time block has changed.

Parameters:
pfSucceeded Will be set to true upon success.
See also:
IProximityReader::TimeSchemes, IProximityReader::CreateTimeScheme, IProximityReader::RemoveTimeScheme

ITimeBlock::IsValid [out, retval] VARIANT_BOOL *  pfValid  ) 
 

Returns true if this time block is set.

If the time block contains invalid values (also when it is removed), this property will return false.

Parameters:
pfValid Receives the end time of this time block.
Precondition:
pfValid is not NULL.


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