Developer

API Reference

AEEVDateTimePeriod

Brew Release
Brew MP 1.0.2
See Also
None.
Description
Specifies the date, date-time, Duration or Period type values.
Members
  • dwValueType       : Specifies the value type.
                           AEEVVALUE_DATE specifies Date type
                           AEEVVALUE_DATE_TIME specifies Date-Time type
                           AEEVVALUE_PERIOD specifies Period type.
                           AEEVVALUE_DURATION specifies duration type.
    
  • bIsDuration       : 1 specifies duration else date-time type. This is valid
                           only if Value is period type
                           (dwValueType = AEEVVALUE_DATE_TIME).
    
  • bIsPriorDuration  : Specifies whether the duration value is prior or not.
                           This will be used for Trigger related properties.
    
  • bIsUTC            : It will be set to 1 if the values (dwValue1 & dwValue2)
                           are in UTC format.
    
  • dwValue1          : Specifies the value in Julian Seconds.
    
  • dwValue2          : Specifies the end date-time in Period type values
                           seperated by solidus character from date-start value 
                           (19960403T020000Z/19960403T040000Z) in Julian Seconds.
                           Julian seconds corresponds to end datetime
                           (19960403T040000Z) will be filled.
    
  • sDuration         : Specifies the duration in Period type values seperated by
                           solidus character from date-start value or Trigger
                           related values. This is valid only if 
                           dwValueType =  AEEVVALUE_PERIOD and bIsDuration = 1 or
                           dwValueType = AEEVVALUE_DURATION and bIsDuration = 1;
Definition
   typedef struct
   {
      AEEVValueType  dwValueType;
      boolean        bIsDuration;
      boolean        bIsPriorDuration;
      boolean        bIsUTC;
      uint32         dwValue1;
      uint32         dwValue2;
      AEEDateTime    sDuration;

   }AEEVDateTimePeriod;   
Comment

-----------------------------------------------------------------------------------------------------------------------------------------
   |  Value Type        		|  dwValue1(JulSecs) 	| dwValue2(JulSecs)  	|   sDuration        		|
-----------------------------------------------------------------------------------------------------------------------------------------
   |AEEVVALUE_DATE  		|  Filled            		|     X    			|   X                		|
   |                    			|                    		|          			|                    		|
   |AEEVVALUE_DATE_TIME 	|  Filled            		|     X              		|   X                		|
   |                    			|                    		|                    		|                    		|
   |AEEVVALUE_PERIOD    	|  Filled            		| Filled if second   	| Filled if second   	|
   |                    			|                    		| value in period is 	| Value in period is 	|
   |                    			|                    		|  Date type         		|  Duration type     	|
   |                    			|                    		|                    		|                    		|
   |AEEVVALUE_DURATION  	|    X               		|    X               		|    Filled          		|
-----------------------------------------------------------------------------------------------------------------------------------------


   If the value is Date type:
      Ex: RDATE:19970406 then :
      dwValueType = AEEVVALUE_DATE, bIsDuration = 0; 
      dwValue1 will be filled with julian  seconds corresponds to RDATE value.

   If the value is Date-Time type:
      Ex: DTSTART:19980118T230000 then :
      dwValuetype = AEEVVALUE_DATE_TIME, bIsDuration = 0;
      dwValue1 will be filled with seconds corresponds to DTSTART value.

      Ex: TRIGGER;VALUE=DATE-TIME:19970317T133000Z
      dwValuetype = AEEVVALUE_DATE_TIME, bIsDuration = 0; bIsUTC = 1;
      dwValue1 will be filled with julian seconds corresponds to TRIGGER value.

   If the value is Duration type:
      Ex: TRIGGER:-PT30M
      dwValuetype = AEEVVALUE_DURATION, bIsDuration = 1;
      bIsPriorDuration = 1;
      m_JD structure will be filled corresponds to TRIGGER duration value.
      
   If the value is Period type:
      Ex; RDATE;VALUE=PERIOD:19960403T020000Z/19960403T040000Z then:
      dwValueType = AEEVVALUE_PERIOD, bIsDuration = 0; bIsUTC = 1;
      dwvalue1 will be filled with julian seconds corresponds to RDATE start
      date-time value.
      dwValue2 will be filled with julian seconds corresponds to RDATE end
      date-time value.

      Ex: RDATE;VALUE=PERIOD:19960404T010000Z/PT3H then:
      dwValueType = AEEVVALUE_PERIOD, bIsDuration = 1;
      dwvalue1 will be filled with seconds corresponds to RDATE start date-time 
      value.
      m_JD structure will be filled corresponds to RDATE duration value.

   dwValue2 will be considered only if dwValueType = AEEVVALUE_PERIOD &
   bIsDuration = 0;
   m_JD will be considered only if
   dwValueType = AEEVVALUE_PERIOD & bIsDuration = 1 or
   dwValuetype = AEEVVALUE_DURATON & bIsDuration = 1;

   It always assumes that dwValue1 and dwValue2 are in same format.
   If the user wants to generate property with UTC time format then bIsUTC 
   should be set to 1 and dwValue1 filled with corresponding seconds.

   Structure To get DTSTART:19970301T200000Z buffer is:
   bIsUTC = 1, dwValue1 filled with seconds all other filelds are zero.

  • Follow