Index Index for
Section 3
Index Alphabetical
listing for C
Bottom of page Bottom of
page		 

csa_delete_calendar(3)


CDE


NAME

  csa_delete_calendar - delete a calendar from the calendar service


SYNOPSIS

  #include <xcsa.h>
  CSA_return_code csa_delete_calendar(CSA_session_handle session,
				      CSA_extension

  *delete_calendar_extensions);


DESCRIPTION

  The csa_delete_calendar function deletes a calendar on the calendar
  service. Only the owner of the calendar, or a user with the owner
  authority, can remove the calendar from the calendar service.


ARGUMENTS

  Session (Session Handle)

  Opaque session handle that represents a session with the calendaring
  service.

  Session handles are created by a logon function call and invalidated with a
  logoff function call. If the session handle is invalid, then the error
  CSA_E_INVALID_SESSION_HANDLE is returned.

  Delete Calendar Extensions (Extension)

  A pointer to an array of CSA_extension structures for this function. The
  array may contain both input extensions for providing additional
  information to the function and output extensions for receiving information
  from the function. A value of NULL indicates that the caller is not using
  any extensions. See the extensions structure for more information.


RETURN VALUE

  Delete Calendar Extensions (Extension)

  If output extensions were passed to the function in the extensions list,
  the results from the service will be available in the extension. See the
  extensions structure for more information. Whether the function succeeded
  or not, and, if not, why. It may be success or one of the values listed
  under ERRORS below.


ERRORS

  The csa_delete_calendar function returns the following error values:

  [CSA_E_DISK_FULL]
      Insufficient disk space was available to complete the requested
      operation (this may refer to local or shared disk space).

  [CSA_E_FAILURE]
      There was a general failure that does not fit the description of any
      other error code.

  [CSA_E_INSUFFICIENT_MEMORY]
      Insufficient memory was available to complete the requested operation.

  [CSA_E_INVALID_FUNCTION_EXT]
      The function extension requested is invalid.

  [CSA_E_INVALID_FLAG]
      A option value in the options argument was invalid.

  [CSA_E_INVALID_PARAMETER]
      A function parameter was invalid.

  [CSA_E_INVALID_SESSION_HANDLE]
      The specified Session Handle is invalid or no longer valid (e.g., after
      logging off).

  [CSA_E_NO_AUTHORITY]
      The user has insufficient authority for this function.

  [CSA_E_NOT_SUPPORTED]
      The operation requested is not supported by this implementation.

  [CSA_E_SERVICE_UNAVAILABLE]
      The requested calendar service is unavailable.

  [CSA_E_UNSUPPORTED_FLAG]
      The option requested is not supported.

  [CSA_E_UNSUPPORTED_FUNCTION_EXT]
      The specified function extension is not supported or CSA_EXT_REQUIRED
      is set.


SEE ALSO

  csa/csa.h(5), csa_add_calendar(3), csa_add_entry(3), csa_call_callbacks(3),
  csa_delete_entry(3), csa_free(3), csa_free_time_search(3),
  csa_list_calendar_attributes(3), csa_list_calendars(3),
  csa_list_entries(3), csa_list_entry_attributes(3),
  csa_list_entry_sequence(3), csa_logoff(3), csa_logon(3), csa_look_up(3),
  csa_query_configuration(3), csa_read_calendar_attributes(3),
  csa_read_entry_attributes(3), csa_read_next_reminder(3),
  csa_register_callback(3), csa_unregister_callback(3),
  csa_update_calendar_attributes(3), csa_update_entry_attributes(3)

Index Index for
Section 3
Index Alphabetical
listing for C
Top of page Top of
page