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

FreeBSD Manual Pages

  
 
  

home | help
csa_read_next_reminder(library call)	  csa_read_next_reminder(library call)

NAME
       csa_read_next_reminder  -- reads	the next reminder of the given type in
       the specified calendar relative to a given time

SYNOPSIS
       #include	<xcsa.h>
       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_reminder_reference **reminder_references,
       CSA_extension *read_next_reminder_extensions);

DESCRIPTION
       The csa_read_next_reminder function reads  the  next  reminder  of  the
       specified  type	in  the	 specified  calendar relative to a given time.
       More than one type of reminder may be  specified.   For	each  reminder
       type  specified,	 the  next  reminder of	that type after	the given time
       will  be	 returned.   The  owner	 of  the  calendar   or	  users	  with
       CSA_OWNER_RIGHTS	 access	 right can read	the next reminder for a	calen-
       dar.

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 Names	(Uint32)
       Specifies the size of reminder_names.

   Reminder Names (Attribute Reference)
       A pointer to an array of	attribute references.  This is an array	of re-
       minder attribute	names.	The names are used as search criteria  to  re-
       turn  the next reminder of each type.  If NULL, then the	first reminder
       after the given time will be returned, no matter	what type it  is.   If
       an invalid reminder type	is specified, then the error CSA_E_INVALID_AT-
       TRIBUTE is returned.

   Given Time (Date Time)
       The given date and time after which the search for the next reminder is
       to  begin.   If	the  date  and time value is incorrect,	then the error
       CSA_E_INVALID_DATE_TIME will be returned.

   Read	Next Reminder 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
   Number Reminders (Uint32)
       The number of reminder reference	structures returned in reminder_refer-
       ences.  If no reminders were found a value of zero is returned.

   Reminder References (Reminder Reference)
       A pointer to an array of	reminder reference structures.	This array  is
       allocated  by  the  service,  and should	be freed with a	single call to
       csa_free(3).

   Read	Next Reminder 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_read_next_reminder 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_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_DATE_TIME
		 An invalid date and time combination was specified.

       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_SERVICE_UNAVAILABLE
		 The requested calendar	service	is unavailable.

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

       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_register_callback(3),
       csa_unregister_callback(3),  csa_update_calendar_attributes(3), csa_up-
       date_entry_attributes(3).

					  csa_read_next_reminder(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_read_next_reminder&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help