csa_list_calendar_UNIXiSystem3V (1csa_list_calendar_attributes(3)
NAME
csa_list_calendar_attributes - list the names of the
calendar attributes associated with a calendar
SYNOPSIS
#include <csa.h>
CSA_return_code csa_list_calendar_attributes(CSA_session_handle session,
CSA_uint32 *number_names,
CSA_attribute_reference **calendar_attributes_names,
CSA_extension *list_calendar_attributes_extensions);
DESCRIPTION
The csa_list_calendar_attributes() function lists the names
of the calendar attributes associated with a calendar.
Using the returned calendar attribute name(s), the attribute
value(s) may be read using the
csa_read_calendar_attributes(3) function. Only the owner of
the calendar, users with CSA_OWNER_RIGHTS, or users with
CSA_VIEW_CALENDAR_ATTRIBUTES access rights can list the
calendar attributes.
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.
List Calendar Attributes 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
Number Names (Uint32)
A pointer to the number of calendar attribute names returned
in calendar_attribute_names.
Calendar Attribute Names (Attribute Reference)
A pointer to an array of attribute names containing the
names of the calendar attributes in the calendar. This
array is allocated by the service, and should be freed with
a single call to csa_free(3).
Page 1 (printed 9/3/04)
csa_list_calendar_UNIXiSystem3V (1csa_list_calendar_attributes(3)
List Calendar Attributes 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_list_calendar_attributes() function returns the
following error values:
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 flag value in the flags 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 flag requested is not supported.
CSA_E_UNSUPPORTED_FUNCTION_EXT
The specified function extension is not supported
or CSA_EXT_REQUIRED is set.
SEE ALSO
Page 2 (printed 9/3/04)
csa_list_calendar_UNIXiSystem3V (1csa_list_calendar_attributes(3)csacsa(5), csa_add_calendar(3), csa_add_entry(3),
csa_call_callbacks(3), csa_delete_calendar(3),
csa_delete_entry(3), csa_free(3), csa_free_time_search(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).
Page 3 (printed 9/3/04)
