Developer

API Reference

IvParm_AddValue()

Brew Release
Brew MP 1.0.2
See Also
None
Description
Add a value to IvParm object.
Parameters
  • pIvParm
    []:
    Pointer to the IvParm interface object.
  • dwParmValue
    []:
    The parameter value.
  • pwszBuf
    []:
    Params which are not listed or which are extended (required for vCal version 2.0)
Interface
Prototype
   int IvParm_AddValue(IvParm      *pIParm,
                       uint32      dwParmValue,
                       AECHAR      *pwszBuf);
   
Return
AEE_SUCCESS : If the parameter was added successfully AEE_EBADPARM : If nParmValue is not valid value AEE_ENOMEMORY : If we are not able to allocate memory AEE_EFAILED : Otherwise
Side Effect
None
Comment
In vCal 1.0/vCard 2.1/vCard 3.0 all the parameter values are predefined. But in vCal 2.0 parameter value can have predefined value or some string. If we want to add predefined value we will set parameter value to nValue else we pass it as string in pwszBuf.
All the encodings shall be in UTF-8 format
   For example if we want to set parametr value "WORK" to "Type",the call would
   be,

      nResult = IvParm_AddValue(pIvParm,
                                AEEVTYPE_WORK,
                                NULL);

   If the user want's to set "MAILTO:server@host.com" value to "DELEGATED-TO"
   parameter then, 

   pwszBuf points to wide string of "MAILTO:server@host.com"

   nResult = IvParm_AddValue(pIvParm,
                             0,
                             pwszBuf);

   

  • Follow