Developer

API Reference

IvProperty_ParseValue()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Parse the value of the property into predefined data types.
Or give out the raw data buffer to the apps if bParseData is FALSE
Parameters
  • pIvProperty
    []:
    Pointert to the IvProperty interface
  • bParseData
    []:
    Indicates whether user wants a raw data buffer or parsed
  • pProperty
    []:
    Pointer to the buffer where parsed property value will be stored.
  • nSize
    []:
    Size of pProperty.
  • pnSizeReq
    []:
    If pProperty is NULL, the size required is returned.
Interface
Prototype
   int IvProperty_ParseValue(IvProperty *pIvProperty,
                             boolean    bParseData,
                             void       *pProperty,
                             int        nSize,
                             int        *pnSizeReq);
  
Return
AEE_SUCCESS : If the Property value was parsed successfully. AEE_EBADPARM : If pSize or pnSizeReq is NULL AEE_EUNSUPPORTED : If the value can not be parsed AEE_EBUFFERTOOSMALL : If the passed in buffer is too small to fill with the parsed value AEE_EFAILED : Otherwise
Side Effect
None.
Comment
This function parses the property into more usable data-types. For Example,
   -----------------------------------------------------------------------
   Property Id               =>       Parsed Result
   ------------------------------------------------------------------------

       AEEVPROPERTY_AALARM              	AEEVAlarm structure
       AEEVPROPERTY_ACTION                AECHAR * 
       AEEVPROPERTY_ATTACH                AECHAR * 
       AEEVPROPERTY_ATTENDEE              AECHAR * 
       AEEVPROPERTY_CALSCALE              AECHAR *, The only supported is,GREGORIAN
       AEEVPROPERTY_CATEGORIES            AECHAR * 
       AEEVPROPERTY_CLASS                 AECHAR * 
       AEEVPROPERTY_COMMENT               AECHAR * 
       AEEVPROPERTY_CONTACT               AECHAR * 
       AEEVPROPERTY_CREATED               AEEVDateTimePeriod structure
       AEEVPROPERTY_DALARM                AEEVAlarm structure
       AEEVPROPERTY_DAYLIGHT              AECHAR *
       AEEVPROPERTY_DCOMPLETED            AEEVDateTimePeriod structure
       AEEVPROPERTY_DCREATED              AEEVDateTimePeriod structure
       AEEVPROPERTY_DESCRIPTION           AECHAR * 
       AEEVPROPERTY_DTEND                 AEEVDateTimePeriod structure
       AEEVPROPERTY_DTSTAMP               AEEVDateTimePeriod structure
       AEEVPROPERTY_DTSTART               AEEVDateTimePeriod structure
       AEEVPROPERTY_DUE                   AEEVDateTimePeriod structure
       AEEVPROPERTY_DURATION              AEEDateTime structure
       AEEVPROPERTY_EXDATE                List of AEEVDateTimePeriod structures
       AEEVPROPERTY_EXRULE                AEEVRRule Structure
       AEEVPROPERTY_EXTENDED              AECHAR * 
       AEEVPROPERTY_FREEBUSY              List of AEEVDateTimePeriod structures
       AEEVPROPERTY_GEO                   AEEVGeo Structure
       AEEVPROPERTY_LASTMODIFIED          AEEVDateTimePeriod structure
       AEEVPROPERTY_LOCATION              AECHAR * 
       AEEVPROPERTY_MALARM                AEEVAlarm structure
       AEEVPROPERTY_METHOD                AECHAR * 
       AEEVPROPERTY_ORGANIZER             AECHAR * 
       AEEVPROPERTY_PALARM                AEEVAlarm structure
       AEEVPROPERTY_PERCENT               uint32*
       AEEVPROPERTY_PRIORITY              uint32*
       AEEVPROPERTY_PRODID                AECHAR * 
       AEEVPROPERTY_RDATE                 List of AEEVDateTimePeriod structures
       AEEVPROPERTY_RECUR_ID              AEEVDateTimePeriod structure
       AEEVPROPERTY_RELATED               AECHAR * 
       AEEVPROPERTY_REPEAT                uint32*
       AEEVPROPERTY_RESOURCES             AECHAR * 
       AEEVPROPERTY_RNUM                  uint32*
       AEEVPROPERTY_RRULE                 AEEVRRule Structure
       AEEVPROPERTY_RSTATUS               AECHAR * 
       AEEVPROPERTY_SEQUENCE              uint32*
       AEEVPROPERTY_SORTSTRING            AECHAR * 
       AEEVPROPERTY_STATUS                AECHAR *
       AEEVPROPERTY_SUMMARY               AECHAR * 
       AEEVPROPERTY_TIMEZONE              int32*
       AEEVPROPERTY_TRANSP                AECHAR *
       AEEVPROPERTY_TRIGGER               AEEVDateTimePeriod Structure
       AEEVPROPERTY_TZID                  AECHAR * 
       AEEVPROPERTY_TZNAME                AECHAR * 
       AEEVPROPERTY_TZOFFSETFROM          int32*
       AEEVPROPERTY_TZOFFSETTO            int32*
       AEEVPROPERTY_TZURL                 AECHAR * 
       AEEVPROPERTY_UID                   AECHAR * 
       AEEVPROPERTY_URL                   AECHAR * 
       AEEVPROPERTY_VERSION               AECHAR * 
       AEEVPROPERTY_XRULE                 AEEVRRule Structure
       AEEVPROPERTY_ADR                   AECHAR *
       AEEVPROPERTY_AGENT                 AEEVData
       AEEVPROPERTY_BIRTHDATE             AECHAR *
       AEEVPROPERTY_EMAIL                 AECHAR * 
       AEEVPROPERTY_FN                    AECHAR * 
       AEEVPROPERTY_KEY                   AEEVData Structure
       AEEVPROPERTY_LABEL                 AECHAR * 
       AEEVPROPERTY_LOGO                  AEEVData
       AEEVPROPERTY_MAILER                AECHAR * 
       AEEVPROPERTY_NAME                  AECHAR *
       AEEVPROPERTY_NICKNAME              AECHAR * 
       AEEVPROPERTY_NOTE                  AECHAR * 
       AEEVPROPERTY_ORG                   AECHAR *   
       AEEVPROPERTY_PHOTO                 AEEVData
       AEEVPROPERTY_REV                   AEEVDateTimePeriod Structure
       AEEVPROPERTY_ROLE                  AECHAR * 
       AEEVPROPERTY_SOUND                 AEEVData Structure
       AEEVPROPERTY_TEL                   AECHAR * 
       AEEVPROPERTY_TITLE                 AECHAR * 
       AEEVPROPERTY_OID                   uint32 *
       AEEVPROPERTY_IMPP                  AECHAR *
       AEEVPROPERTY_XCOMPNAME             AECHAR *
   ----------------------------------------------------------------------
This function takes care of the encoding schemes, character sets,etc. (i.e. All the different parameters associated with the property) and return the result in the above mentioned data-types.
Since the definition is generic, support for parsing more and more properties can be added at later point.
  • Follow