Libical API Documentation
3.0
|
A set of functions to handle iCal attachments. More...
Go to the source code of this file.
Typedefs | |
typedef struct icalattach_impl | icalattach |
An iCal attach object representing a link to a document object. More... | |
typedef void(* | icalattach_free_fn_t) (unsigned char *data, void *user_data) |
(unused) Function to be called to free the data of an icalattach object. Currently not used More... | |
Functions | |
unsigned char * | icalattach_get_data (icalattach *attach) |
Returns the data of the icalattach object. More... | |
int | icalattach_get_is_url (icalattach *attach) |
Determines if attach is an URL. More... | |
const char * | icalattach_get_url (icalattach *attach) |
Returns the URL of the icalattach object. More... | |
icalattach * | icalattach_new_from_data (const char *data, icalattach_free_fn_t free_fn, void *free_fn_data) |
Create new icalattach object from data. More... | |
icalattach * | icalattach_new_from_url (const char *url) |
Create new icalattach object from a URL. More... | |
void | icalattach_ref (icalattach *attach) |
Increments reference count of the icalattach. More... | |
void | icalattach_unref (icalattach *attach) |
Decrements reference count of the icalattach. More... | |
A set of functions to handle iCal attachments.
With the ATTACH
property, the iCal standard defines a way to associate a document object with a calendar component.
These are represented with icalattach objects in libical. This file contains functions to create and work with these objects.
An iCal attach object representing a link to a document object.
Represents an association with a document object. icalattach objects are reference counted, meaning that if the last reference to them is removed (with icalattach_unref()), they are destroyed.
icalattach_free_fn_t |
(unused) Function to be called to free the data of an icalattach object. Currently not used
This function type is used to free the data from an icalattach object created with icalattach_new_from_data(). It is currently not used
unsigned char* icalattach_get_data | ( | icalattach * | attach | ) |
Returns the data of the icalattach object.
attach | The object from which to return the data |
Returns the URL of the icalattach object.
NULL
and set icalerrno to ICAL_BADARG_ERROR if attach is NULL
. Undefined behaviour if the object is a URL (check with icalattach_get_is_url()).int icalattach_get_is_url | ( | icalattach * | attach | ) |
Determines if attach is an URL.
attach | the icalattach object to check |
NULL
and sets icalerrno to ICAL_BADARG_ERROR if attach is NULL
.const char* icalattach_get_url | ( | icalattach * | attach | ) |
Returns the URL of the icalattach object.
attach | The object from which to return the URL |
Returns the URL of the icalattach object.
NULL
and set icalerrno to ICAL_BADARG_ERROR if attach is NULL
. Undefined behaviour if the object is not a URL (check with icalattach_get_is_url()).icalattach* icalattach_new_from_data | ( | const char * | data, |
icalattach_free_fn_t | free_fn, | ||
void * | free_fn_data | ||
) |
Create new icalattach object from data.
data | The data to create the icalattach from |
free_fn | (unused) The function to free the data |
free_fn_data | (unused) Data to pass to the free_fn |
NULL
, it returns NULL
and sets icalerrno to ICAL_BADARG_ERROR. If there was an error allocating memory, it returns NULL
and sets errno
to ENOMEM
.icalattach* icalattach_new_from_url | ( | const char * | url | ) |
Create new icalattach object from a URL.
url | The URL to create the object from |
NULL
, it returns NULL
and sets icalerrno to ICAL_BADARG_ERROR. If there was an error allocating memory, it returns NULL
and sets errno
to ENOMEM
.void icalattach_ref | ( | icalattach * | attach | ) |
Increments reference count of the icalattach.
attach | The object to increase the reference count of |
NULL
, or the reference count is smaller than 0, it sets icalerrno to ICAL_BADARG_ERROR.void icalattach_unref | ( | icalattach * | attach | ) |
Decrements reference count of the icalattach.
attach | The object to decrease the reference count of |
Decreases the reference count of attach. If this was the last user of the object, it is freed.
NULL
, or the reference count is smaller than 0, it sets icalerrno to ICAL_BADARG_ERROR.