*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->HP-UX 11i man pages -> csa_logon (3)              


 csa_logon(library call)                             csa_logon(library call)

 NAME    [Toc]    [Back]
      csa_logon - log on to the calendar service and establish a session
      with a calendar

 SYNOPSIS    [Toc]    [Back]
      #include <xcsa.h>
      CSA_return_code csa_logon(
      CSA_service_reference calendar_service,
      CSA_calendar_user *user,
      CSA_string password,
      CSA_string character_set,
      CSA_string required_csa_version,
      CSA_session_handle *session,
      CSA_extension *logon_extensions);

 DESCRIPTION    [Toc]    [Back]
      The csa_logon function allows the calling application to logon to the
      calendar service.  If the specified calendar does not exist, then the
      error CSA_E_CALENDAR_NOT_EXIST is returned.

      The function returns a Session Handle that the application will use in
      subsequent CSA calls.

 ARGUMENTS    [Toc]    [Back]
    Calendar Service (Service Reference)
      A calendar service name specifying the requested calendaring service,
      (e.g., the path to a calendar store or a remote server node name).
      This value may be NULL if the underlying calendaring service does not
      require a service name or if UI is allowed.  This may be necessary on
      some implementations and ignored on others.

    User (Calendar User)    [Toc]    [Back]
      A pointer to the calendar user structure that identifies the user and
      calendar to the calendaring service.  This value may be NULL.

    Password (String)    [Toc]    [Back]
      A string containing the password required for access to the CSA
      service.  This value may be NULL if the underlying calendaring service
      does not require a password or if UI is allowed.

    Character Set (String)    [Toc]    [Back]
      A CSA formal public identifier string for the character set of strings
      used by the CSA caller.  The client may pass NULL in which case the
      character set used is determined by the CSA service.  The supported
      values are implementation specific.

    Required CSA Version (String)    [Toc]    [Back]
      The formal public identifier for the CSA version number required by
      the application.  For this version of the specification this string
      must be ``-//XAPIA/CSA/VERSION1/NONSGML CSA Version 1//EN''.

                                    - 1 -       Formatted:  January 24, 2005

 csa_logon(library call)                             csa_logon(library call)

    Logon Extensions (Extensions)    [Toc]    [Back]
      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.

      Through extensions, the application can find out which extensions are
      available and set which data extensions will be active for the

 RETURN VALUE    [Toc]    [Back]
    Session (Session Handle)
      Opaque session handle that represents a session with the CSA calendar.

    Logon Extensions (Extensions)    [Toc]    [Back]
      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    [Toc]    [Back]
      The csa_logon function returns the following error values:

                The specified calendar does not exist.

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

                Insufficient memory was available to complete the requested

                The underlying calendar service is invalid, so logging on
                cannot be completed.

                The specified logon configuration is inconsistent with the
                selected calendar service.

                The data extension requested is invalid.

                A flag value in the flags argument was invalid.

                                    - 2 -       Formatted:  January 24, 2005

 csa_logon(library call)                             csa_logon(library call)

                The function extension requested is invalid.

                A function parameter was invalid.

                The password is incorrect.

                The specified calendar user is invalid.

                The user has insufficient authority for this function.

                A password is required on this calendar service.

                The requested calendar service is unavailable.

                The implementation cannot support the additional logon of
                another calendar user at this time.

                The character set requested is not supported.

                The data extension requested is not supported.

                The specified function extension is not supported or
                CSA_EXT_REQUIRED is set.

                The specification version specified in the call cannot be
                supported by this CSA implementation.

 SEE ALSO    [Toc]    [Back]
      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_attributes(3), csa_list_entry_sequence(3),
      csa_logoff(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),

                                    - 3 -       Formatted:  January 24, 2005
[ Back ]
 Similar pages
Name OS Title
csa_delete_calendar HP-UX delete a calendar from the calendar service
csa_add_calendar HP-UX add a calendar to the calendar service
csa_x_process_updates HP-UX invoke a calendar application's calendar event handler
csa_read_calendar_attributes HP-UX read and return the calendar attributes values for a calendar
csa_list_entry_sequence HP-UX lists the recurring calendar entries that are associated with a calendar entry
csa_update_calendar_attributes HP-UX update the calendar attributes values for a calendar
csa_list_calendar_attributes HP-UX list the names of the calendar attributes associated with a calendar
csa_logoff HP-UX terminate a session with a calendar
csa_list_calendars HP-UX list the calendars supported by a calendar service
csa_read_entry_attributes HP-UX read and return the calendar entry attribute values for a specified calendar entry
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service