Libical API Documentation  3.0
icalparameter.h
Go to the documentation of this file.
1 /*======================================================================
2  FILE: icalparam.h
3  CREATOR: eric 20 March 1999
4 
5  (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com>
6 
7  This library is free software; you can redistribute it and/or modify
8  it under the terms of either:
9 
10  The LGPL as published by the Free Software Foundation, version
11  2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html
12 
13  Or:
14 
15  The Mozilla Public License Version 2.0. You may obtain a copy of
16  the License at https://www.mozilla.org/MPL/
17 ======================================================================*/
18 
26 #ifndef ICALPARAMETER_H
27 #define ICALPARAMETER_H
28 
29 #include "libical_ical_export.h"
30 #include "icalderivedparameter.h"
31 
32 /* Declared in icalderivedparameter.h */
33 /*typedef struct icalparameter_impl icalparameter;*/
34 
62 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new(icalparameter_kind kind);
63 
95 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_clone(icalparameter *p);
96 
123 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_string(const char *value);
124 
152 LIBICAL_ICAL_EXPORT icalparameter *icalparameter_new_from_value_string(icalparameter_kind kind,
153  const char *value);
154 
176 LIBICAL_ICAL_EXPORT void icalparameter_free(icalparameter *parameter);
177 
208 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string(icalparameter *parameter);
209 
242 LIBICAL_ICAL_EXPORT char *icalparameter_as_ical_string_r(icalparameter *parameter);
243 
265 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_isa(icalparameter *parameter);
266 
290 LIBICAL_ICAL_EXPORT int icalparameter_isa_parameter(void *param);
291 
292 /* Access the name of an X parameter */
293 
322 LIBICAL_ICAL_EXPORT void icalparameter_set_xname(icalparameter *param, const char *v);
323 
352 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xname(icalparameter *param);
353 
383 LIBICAL_ICAL_EXPORT void icalparameter_set_xvalue(icalparameter *param, const char *v);
384 
414 LIBICAL_ICAL_EXPORT const char *icalparameter_get_xvalue(icalparameter *param);
415 
416 /* Access the name of an IANA parameter */
417 
446 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_name(icalparameter *param, const char *v);
447 
476 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_name(icalparameter *param);
477 
507 LIBICAL_ICAL_EXPORT void icalparameter_set_iana_value(icalparameter *param, const char *v);
508 
538 LIBICAL_ICAL_EXPORT const char *icalparameter_get_iana_value(icalparameter *param);
539 
567 LIBICAL_ICAL_EXPORT int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2);
568 
569 /* Convert enumerations */
570 
590 LIBICAL_ICAL_EXPORT const char *icalparameter_kind_to_string(icalparameter_kind kind);
591 
613 LIBICAL_ICAL_EXPORT icalparameter_kind icalparameter_string_to_kind(const char *string);
614 
626 LIBICAL_ICAL_EXPORT int icalparameter_kind_is_valid(const icalparameter_kind kind);
627 
628 #endif
const char * icalparameter_get_iana_value(icalparameter *param)
Returns the IANA value of param.
Definition: icalparameter.c:395
const char * icalparameter_get_iana_name(icalparameter *param)
Returns the IANA name of param.
Definition: icalparameter.c:405
icalparameter * icalparameter_new_clone(icalparameter *p)
Creates new icalparameter as a clone of the given one.
Definition: icalparameter.c:84
int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)
Determines if two parameters have the same name.
Definition: icalparameter.c:424
const char * icalparameter_kind_to_string(icalparameter_kind kind)
Returns a string representing the given icalparameter_kind.
char * icalparameter_as_ical_string_r(icalparameter *parameter)
Converts icalparameter into an string representation according to RFC5445/RFC6868.
Definition: icalparameter.c:268
icalparameter_kind icalparameter_isa(icalparameter *parameter)
Definition: icalparameter.c:320
int icalparameter_kind_is_valid(const icalparameter_kind kind)
Checks the validity of a icalparameter_kind.
const char * icalparameter_get_xname(icalparameter *param)
Returns the X-name of param.
Definition: icalparameter.c:360
void icalparameter_set_xvalue(icalparameter *param, const char *v)
Sets the X-value of param to v.
Definition: icalparameter.c:367
void icalparameter_set_xname(icalparameter *param, const char *v)
Sets the X-name of param to v.
Definition: icalparameter.c:344
void icalparameter_set_iana_name(icalparameter *param, const char *v)
Sets the IANA name of param to v.
Definition: icalparameter.c:400
const char * icalparameter_get_xvalue(icalparameter *param)
Returns the X-value of param.
Definition: icalparameter.c:383
icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)
Creates new icalparameter of a given kind with a given value.
icalparameter_kind icalparameter_string_to_kind(const char *string)
Returns the icalparameter_kind for a given string.
icalparameter * icalparameter_new_from_string(const char *value)
Creates new icalparameter object from string.
Definition: icalparameter.c:119
int icalparameter_isa_parameter(void *param)
Definition: icalparameter.c:329
char * icalparameter_as_ical_string(icalparameter *parameter)
Converts icalparameter into a string representation.
Definition: icalparameter.c:168
void icalparameter_set_iana_value(icalparameter *param, const char *v)
Sets the IANA value of param to v.
Definition: icalparameter.c:390
icalparameter * icalparameter_new(icalparameter_kind kind)
Creates new icalparameter object.
Definition: icalparameter.c:53
void icalparameter_free(icalparameter *parameter)
Frees an icalparameter object.
Definition: icalparameter.c:60