Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
csa_update_calendar_attributes(libcsa_update_calendar_attributes(library call)

NAME
       csa_update_calendar_attributes -- update	the calendar attributes	values
       for a calendar

SYNOPSIS
       #include	<xcsa.h>
       CSA_return_code csa_update_calendar_attributes(
       CSA_session_handle session,
       CSA_uint32 number_attributes,
       CSA_attribute *calendar_attributes,
       CSA_extension *update_calendar_attributes_extensions);

DESCRIPTION
       The csa_update_calendar_attributes function update the  values  of  the
       calendar	 attributes  of	the specified calendar.	 The existing value of
       each specified attribute	will be	replaced by the	new value specified in
       calendar_attributes.  New  attributes  can be added using this function
       and existing attributes can be effectively deleted by setting the value
       part  of	the CSA_attributes structure to	NULL. If a read-only attribute
       is specified, the error CSA_E_READ_ONLY is returned  by	the  function.
       If the function returns an error, none of the specified attributes will
       be  updated.   Only   the   owner   of	the   calendar,	  users	  with
       CSA_OWNER_RIGHTS,   users  with	CSA_INSERT_CALENDAR_ATTRIBUTES	access
       rights, or users	with CSA_UPDATE_CALENDAR_ATTRIBUTES,  can  update  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.

   Number Attributes (Uint32)
       The number of calendar attributes in calendar_attributes.

   Calendar Attributes (Attribute)
       A pointer to an array of	attribute structures containing	the new	values
       for the calendar	attributes.

   Update 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	infor-
       mation from the function.  A value of NULL indicates that the caller is
       not using any extensions.  See the extensions structure for more	infor-
       mation.

RETURN VALUE
   Update 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	 func-
       tion  succeeded	or not,	and, if	not, why.  It may be success or	one of
       the values listed under ERRORS below.

ERRORS
       The csa_update_calendar_attributes function returns the following error
       values:

       CSA_E_DISK_FULL
		 Insufficient  disk  space  was	 available to complete the re-
		 quested 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_ATTRIBUTE
		 An attribute was specified that was not defined by this spec-
		 ification and the implementation does not support the	attri-
		 bute as an application	specific attribute.

       CSA_E_INVALID_ATTRIBUTE_VALUE
		 An invalid attribute value was	specified for an attribute.

       CSA_E_INVALID_DATA_EXT
		 The data extension requested is invalid.

       CSA_E_INVALID_FLAG
		 A flag	value in the flags argument was	invalid.

       CSA_E_INVALID_FUNCTION_EXT
		 The function extension	requested is 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  implementa-
		 tion.

       CSA_E_READ_ONLY
		 An attempt was	made to	update a readonly attribute.

       CSA_E_SERVICE_UNAVAILABLE
		 The requested calendar	service	is unavailable.

       CSA_E_TEXT_TOO_LARGE
		 The  size  of the text	string passed to the implementation is
		 too large.

       CSA_E_UNSUPPORTED_ATTRIBUTE
		 An attribute was encountered that is unsupported by the  cal-
		 endar service.

       CSA_E_UNSUPPORTED_DATA_EXT
		 The data extension requested is not supported.

       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_calendar_attributes(3),
       csa_list_calendars(3),	   csa_list_entries(3),	    csa_list_entry_at-
       tributes(3), csa_list_entry_sequence(3),	 csa_logoff(3),	 csa_logon(3),
       csa_look_up(3),	  csa_query_configuration(3),	 csa_read_calendar_at-
       tributes(3),  csa_read_entry_attributes(3),  csa_read_next_reminder(3),
       csa_register_callback(3),   csa_unregister_callback(3),	csa_update_en-
       try_attributes(3).

				  csa_update_calendar_attributes(library call)

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | RETURN VALUE | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=csa_update_calendar_attributes&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help