Libical API Documentation 4.0 UNRELEASED Go to the stable 3.0 documentation
Loading...
Searching...
No Matches
icalvalue.h File Reference

Go to the source code of this file.

Functions

const char * icalvalue_as_ical_string (const icalvalue *value)
char * icalvalue_as_ical_string_r (const icalvalue *value)
icalvalue * icalvalue_clone (const icalvalue *old)
 Deeply clones an icalvalue.
icalparameter_xliccomparetype icalvalue_compare (const icalvalue *a, const icalvalue *b)
bool icalvalue_decode_ical_string (const char *szText, char *szDecText, int nMaxBufferLen)
bool icalvalue_encode_ical_string (const char *szText, char *szEncText, int MaxBufferLen)
void icalvalue_free (icalvalue *value)
bool icalvalue_is_valid (const icalvalue *value)
icalvalue_kind icalvalue_isa (const icalvalue *value)
bool icalvalue_isa_value (void *)
bool icalvalue_kind_is_valid (const icalvalue_kind kind)
const char * icalvalue_kind_to_string (const icalvalue_kind kind)
icalvalue * icalvalue_new (icalvalue_kind kind)
icalvalue * icalvalue_new_from_string (icalvalue_kind kind, const char *str)
void icalvalue_reset_kind (icalvalue *value)
icalvalue_kind icalvalue_string_to_kind (const char *str)

Function Documentation

◆ icalvalue_clone()

icalvalue * icalvalue_clone ( const icalvalue * old)

Deeply clones an icalvalue.

Returns a pointer to the memory for the newly cloned icalvalue.

Since
4.0

◆ icalvalue_compare()

icalparameter_xliccomparetype icalvalue_compare ( const icalvalue * a,
const icalvalue * b )

Compares two icalvalues.

Parameters
aan icalvalue to compare
ban icalvalue to compare
Returns
an icalparameter_xliccomparetype representing how a and b compare; if the values do not have the same type ICAL_XLICCOMPARETYPE_NOTEQUAL is returned; ICAL_XLICCOMPARETYPE_NONE is returned if the values type is unknown or one of the values is null.

◆ icalvalue_decode_ical_string()

bool icalvalue_decode_ical_string ( const char * szText,
char * szDecText,
int nMaxBufferLen )

Extract the original character string encoded by the above function

◆ icalvalue_encode_ical_string()

bool icalvalue_encode_ical_string ( const char * szText,
char * szEncText,
int MaxBufferLen )

Encode a character string in ical format, escape certain characters, etc.

◆ icalvalue_kind_is_valid()

bool icalvalue_kind_is_valid ( const icalvalue_kind kind)

Check validity of a specific icalvalue_kind

◆ icalvalue_reset_kind()

void icalvalue_reset_kind ( icalvalue * value)

Resets the icalvalue_kind of the specified icalvalue.

Parameters
valuea pointer to a valid icalvalue

Examine the value and possibly change the kind to agree with the value