Entry Management Functions

This section contains descriptions for the entry management functions supported in the CDE implementation. See the relevant man page for more information.

Add Entry - Adds an entry to the specified calendar.

CSA_return_code
csa_add_entry(
  CSA_session_handle      session,
  CSA_uint32      number_attributes,
  CSA_attribute      *entry_attributes,
  CSA_entry_handle      *entry,
  CSA_extension      *add_entry_extensions
);

Delete Entry - Deletes an entry from the specified calendar.

CSA_return_code
csa_delete_entry(
        CSA_session_handle      session,
        CSA_entry_handle        entry,
        CSA_enum                delete_scope,
        CSA_extension           *delete_entry_extensions
);

List Entries - Lists the calendar entries that match all the attribute search criteria.

CSA_return_code
csa_list_entries(
        CSA_session_handle      session,
        CSA_uint32              number_attributes,
        CSA_attribute           *entry_attributes,
        CSA_enum                *list_operators,
        CSA_uint32              *number_entries,
        CSA_entry_handle        **entries,
        CSA_extension           *list_entries_extensions
);

The following information details more about the operators specified in list_operators:

Only the operators CSA_MATCH_ANY and CSA_MATCH_EQUAL_TO are supported for the attribute value types CSA_VALUE_REMINDER, CSA_VALUE_CALENDAR_USER, and CSA_VALUE_DATE_TIME_RANGE.

Only the operators CSA_MATCH_ANY, CSA_MATCH_EQUAL_TO, CSA_MATCH_NOT_EQUAL_TO, and CSA_MATCH_CONTAIN are supported for the attribute value type CSA_VALUE_STRING. The operator CSA_MATCH_CONTAIN only applies to CSA_VALUE_STRING type of attributes.

Matching of attributes with the value types CSA_VALUE_OPAQUE_DATA, CSA_VALUE_ACCESS_LIST, CSA_VALUE_ATTENDEE_LIST, and, CSA_VALUE_DATE_TIME_LIST are not supported. The only exception is the attribute CSA_ENTRY_ATTR_REFERENCE_IDENTIFIER. The operator CSA_MATCH_EQUAL_TO is supported for this attribute.

List Entry Attributes - Lists the names of the entry attributes associated with the specified entry.

CSA_return_code
csa_list_entry_attributes(
  CSA_session_handle       session,
      CSA_entry_handle       entry,
  CSA_uint32       *number_names,
  CSA_attribute_reference       **entry_attribute_names,
  CSA_extension       *list_entry_attributes_extensions
);

List Entry Sequence - Lists the recurring calendar entries that are associated with a calendar entry.

CSA_return_code
csa_list_entry_sequence(
  CSA_session_handle      session,
  CSA_entry_handle      entry,
  CSA_date_time_range      time_range,
  CSA_uint32      *number_entries,
  CSA_entry_handle      **entry_list,
  CSA_extension      *list_entry_sequences_extensions
);

CSA_E_INVALID_PARAMETER is returned if the specified entry is a one-time entry.

Read Entry Attributes - Reads and returns the calendar entry attribute values for a specified entry.

CSA_return_code
csa_read_entry_attributes(
       CSA_session_handle        session,
       CSA_entry_handle        entry,
       CSA_uint32        number_names,
       CSA_attribute_reference *attribute_names,
       CSA_uint32        *number_attributes,
       CSA_attribute        **entry_attributes,
       CSA_extension        *read_entry_attributes_extensions
);

Read Next Reminder - Reads the next reminder of the given type in the specified calendar relative to a given time.

CSA_return_code
csa_read_next_reminder(
  CSA_session_handle      session,
  CSA_uint32      number_names,
  CSA_attribute_reference *reminder_names,
  CSA_date_time      given_time,
  CSA_uint32      *number_reminders,
  CSA_remainder_reference **reminder_references,
  CSA_extension      *read_next_reminder_extensions
);

Update Entry Attributes - Updates the calendar entry attributes.

CSA_return_code
csa_update_entry_attributes(
        CSA_session_handle        session,
        CSA_entry_handle        entry,
        CSA_enum        update_scope,
        CSA_boolean        update_propagation,
        CSA_uint32        number_attributes,
        CSA_attribute        *entry_attributes,
        CSA_entry_handle        *new_entry,
        CSA_extension        *update_entry_attributes_extensions
);

Update propagation is not supported; the update_propagation argument should be set to CSA_FALSE.

Entry Management Functions

Technical documentation

» Table of Contents

» Glossary

» Index