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

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


 csa_look_up(library call)                         csa_look_up(library call)

 NAME    [Toc]    [Back]
      csa_look_up - Looks up calendar information

 SYNOPSIS    [Toc]    [Back]
      #include <xcsa.h>
      CSA_return_code csa_look_up(
      CSA_session_handle session,
      CSA_calendar_user *users,
      CSA_flags look_up_flags,
      CSA_uint32 *number_users,
      CSA_calendar_user **user_list,
      CSA_extension *look_up_extensions);

 DESCRIPTION    [Toc]    [Back]
      The csa_look_up function looks up calendar addressing information in
      the directory provided by the CSA calendaring service.  It primarily
      is used to resolves a user's friendly name to a calendar address.

      Multiple addresses may be returned.  An array of calendar user
      descriptors is allocated and returned containing fully resolved
      information about each entry.

 ARGUMENTS    [Toc]    [Back]
    Session (Session Handle)
      Opaque session handle that represents a session with the calendaring

      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

    Users(Calendar User)    [Toc]    [Back]
      A pointer to a calendar user structure containing the user-friendly
      names whose calendar address is to be looked up.  For name resolution,
      the name field in the structure contains the user name to be resolved.
      The user type can be set to provide information on desired resolution
      of the name.  See the calendar user structure documentation for
      possible types.  For displaying calendar user details, the calendar
      user structure must contain an entry that resolves to only one user.
      If not, the error CSA_E_AMBIGUOUS_USER will be returned.  For both
      name resolution and displaying user details, all user structures
      except the first will be ignored.

    Look Up Flags (Flags)    [Toc]    [Back]
      Bit mask of flags.  Unspecified flags should always be passed as 0.
      Undocumented flags are reserved.  Flag settings include:

                If set, the search method should be prefix.  Prefix search

                                    - 1 -       Formatted:  January 24, 2005

 csa_look_up(library call)                         csa_look_up(library call)

                means that all names matching the prefix string, beginning
                at the first character of the name, will be matched.  If not
                set, the search method should be exact match.  CSA
                implementations are required to support simple prefix
                searching.  The availability of wild-card or substring
                searches is optional.

                If set, the function will return a user record for the
                identity of the user in the calendar system.  If this cannot
                be uniquely determined, ambiguous name resolution will be
                carried out.  This allows the application to find out the
                address of the current user.

    Look Up Extensions (Extension)    [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.

 RETURN VALUE    [Toc]    [Back]
    Number Users (Uint32)
      A pointer to the number of elements user_list. If no names match the
      criteria, a value of zero is returned, and the error
      CSA_E_USER_NOT_FOUND is returned.

    User List (Calendar User)    [Toc]    [Back]
      A pointer to an array of one or more calendar user structures
      allocated by csa_look_up(3). The structure may then be used to fill in
      an attendee list structure.  This pointer is allocated by the service,
      and should be freed with a single call to csa_free(3).

    Look Up Extensions (Extension)    [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_look_up function returns the following error values:

                The calendar user's name is ambiguous; multiple matches have
                been found.

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

                                    - 2 -       Formatted:  January 24, 2005

 csa_look_up(library call)                         csa_look_up(library call)

                Insufficient memory was available to complete the requested

                The data extension requested is invalid.

                A flag value in the flags argument was invalid.

                The function extension requested is invalid.

                A function parameter was invalid.

                The specified Session Handle is invalid or no longer valid
                (e.g., after logging off).

                The operation requested is not supported by this

                The requested calendar service is unavailable.

                The data extension requested is not supported.

                The flag requested is not supported.

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

                One or more of the specified calendar users were not found.

 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_logon(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_list_entry_sequence HP-UX lists the recurring calendar entries that are associated with a calendar entry
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_logon HP-UX log on to the calendar service and establish a session with a calendar
csa_list_calendar_attributes HP-UX list the names of the calendar attributes associated with a calendar
csa_update_calendar_attributes HP-UX update the calendar attributes values for a calendar
csa_delete_calendar HP-UX delete a calendar from the calendar service
csa_read_entry_attributes HP-UX read and return the calendar entry attribute values for a specified calendar entry
csa_add_calendar HP-UX add a calendar to the calendar service
ical IRIX calendar
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service