JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Sun QFS and Sun Storage Archive Manager 5.3 Reference Manual     Sun QFS and Sun Storage Archive Manager 5.3 Information Library
search filter icon
search icon

Document Information

Preface

1.  User Commands (Man Pages Section 1)

2.  Maintenance Commands (Man Pages Section 1M)

3.  Library Functions (Man Pages Section 3)

intro_libsam(3)

intro_libsamrpc(3)

qfs_listio(3)

sam_advise(3)

sam_archive(3)

sam_audit(3)

sam_cancelstage(3)

sam_chmed(3)

sam_clear_request(3)

sam_closecat(3)

sam_damage(3)

sam_devstat(3)

sam_devstr(3)

sam_errno(3)

sam_exarchive(3)

sam_export(3)

sam_getcatalog(3)

sam_getfsdata(3)

sam_getfsdisks(3)

sam_import(3)

sam_load(3)

sam_lstat(3)

sam_mig_create_file(3)

sam_mig_mount_media(3)

sam_mig_rearchive(3)

sam_mig_release_device(3)

sam_mig_stage_end(3)

sam_mig_stage_error(3)

sam_mig_stage_file(3)

sam_mig_stage_write(3)

sam_move(3)

sam_odlabel(3)

sam_opencat(3)

sam_readrminfo(3)

sam_rearch(3)

sam_release(3)

sam_request(3)

sam_restore_copy(3)

sam_restore_file(3)

sam_segment(3)

sam_segment_stat(3)

sam_segment_vsn_stat(3)

sam_set_fs_contig(3)

sam_set_fs_thresh(3)

sam_set_state(3)

sam_setfa(3)

sam_settings(3)

sam_ssum(3)

sam_stage(3)

sam_stat(3)

sam_tplabel(3)

sam_unarchive(3)

sam_undamage(3)

sam_unload(3)

sam_unrearch(3)

sam_vsn_stat(3)

usam_mig_cancel_stage_req(3)

usam_mig_initialize(3)

usam_mig_stage_file_req(3)

4.  Library Functions (Man Pages Section 3X)

5.  File Formats (Man Pages Section 4)

6.  Standards, Environment, and Macros (Man Pages Section 5)

7.  Device and Network Interfaces (Man Pages Section 7)

sam_opencat(3)

NAME
     sam_opencat - Accesses an  automated  library's  catalog  to
     read entries

SYNOPSIS
     cc [ flag  ... ] file    ...  -L/opt/SUNWsamfs/lib  -lsam  [
     library ... ]

     #include "/opt/SUNWsamfs/include/catalog.h"

     int sam_opencat(const char *path, struct  sam_cat_tbl  *buf,
     size_t bufsize);

AVAILABILITY
     32-bit programs only

DESCRIPTION
     sam_opencat() initiates  access  to  the  automated  library
     catalog pointed to by path.  The string which path points to
     is limited to 127  characters.   It  returns  a  sam_cat_tbl
     structure  in  the  area  pointed to by buf . bufsize is the
     length of the user's  buffer  to  which  buf  points.   This
     should   be   equal   to   or   greater  than  sizeof(struct
     sam_cat_tbl).

     The user may have access to at most MAX_CAT catalogs at  any
     one time.

     The contents of a sam_cat_tbl structure include the  follow-
     ing members:

          /* catalog table */
          time_t   audit_time;  /* Audit time */
          int      version;     /* Catalog version number */
          int      count;       /* Number of slots */
          char     media[4];    /* Media type, if entire catalog is one */

     Following the call to sam_opencat(), entries in the  library
     catalog are obtained using sam_getcatalog().

RETURN VALUES
     Upon successful completion, a catalog "handle" is  returned,
     which is an integer equal to or greater than zero.

     This   "handle"   is   used   on   subsequent    calls    to
     sam_getcatalog()  to  specify  the catalog to access, and is
     also used by sam_closecat() to deallocate the  "handle"  and
     end access to the catalog.

     If the call  to  sam_opencat()  fails,  a  value  of  -1  is
     returned and errno is set to indicate the error.

ERRORS
     sam_opencat() fails if one or more of  the  following  error
     conditions are true:

     EMFILE              The user already has access  to  MAX_CAT
                         catalogs  ,  or the process has too many
                         open files.

     EINVAL              bufsize is set to an invalid  value,  or
                         either path or buf is a null pointer.

     ER_UNABLE_TO_INIT_CATALOG
                         This process was  unable  to  initialize
                         the catalog data.

     ENOENT              There is no active catalog file with the
                         name given.

SEE ALSO
     sam_closecat(3), sam_getcatalog(3)