Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

csa_free(3) [hpux man page]

csa_free(library call)													    csa_free(library call)

NAME
csa_free -- free memory allocated by the calendaring service SYNOPSIS
#include <xcsa.h> CSA_return_code csa_free( CSA_buffer memory); DESCRIPTION
The csa_free function frees memory allocated by the calendaring service. After the call, the pointer memory will be invalid and should not be referenced again. When any CSA function allocates and returns a buffer to the application, the application will free that memory with this call when it is finished with the memory. When a CSA function returns a base pointer to a complex structure containing several levels of pointers, all the application will do to free the entire structure or array of structures is call this routine with the base pointer returned by the CSA function. The CSA functions that return structures of this form are csa_list_calendars(3), csa_look_up(3), csa_query_configuration(3), csa_list_calendar_attributes(3), csa_read_calendar_attributes(3), csa_free_time_search(3), csa_add_entry(3), csa_list_entries(3), csa_list_entry_attributes(3), csa_list_entry_sequence(3), csa_read_entry_attributes(3), and csa_read_next_reminder(3), csa_update_entry_attributes(3). The behavior of csa_free(3) is undefined when called with a pointer to a memory block not allocated by the calendaring service, a pointer to a memory block that has already been freed, or a pointer contained in a structure returned by the CSA implementation. In some situations, the extensions specified for a function may be a combination of input and output extensions. In this case, the memory returned in the output extensions must be freed one at a time using csa_free(3). ARGUMENTS
Memory (Buffer) A pointer to memory allocated by the calendaring service. A value of NULL will be ignored, but will return the return code CSA_SUCCESS. RETURN VALUE
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_free 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_INVALID_MEMORY A function parameter was invalid. SEE ALSO
csa/csa.h - csacsa(5), csa_add_calendar(3), csa_add_entry(3), csa_call_callbacks(3), csa_delete_calendar(3), csa_delete_entry(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_calen- dar_attributes(3), csa_update_entry_attributes(3). csa_free(library call)

Check Out this Related Man Page

csa_list_calendar_attributes(library call)								csa_list_calendar_attributes(library call)

NAME
csa_list_calendar_attributes -- list the names of the calendar attributes associated with a calendar SYNOPSIS
#include <xcsa.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 calen- dar attribute name(s), the attribute value(s) may be read using the csa_read_calendar_attributes(3) function. Only the owner of the calen- dar, 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). 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
csa/csa.h - 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). csa_list_calendar_attributes(library call)
Man Page