Index for Section 3

Alphabetical listing for S

Bottom of page

st_strerror(3)
NAME
  st_strerror - translate a libst return code to a printable error message

SYNOPSIS
  #include <st.h>

  st_status_t st_strerror(
	  st_status_t errcode,
	  char *buf,
	  int buflen );

LIBRARY
  Symbol Table and Object File Access Library (libst.a)

PARAMETERS
  errcode
      Status code returned by a function defined in the symbol table and
      object file access library (libst.a).

  buf Specifies an address to which st_strerror() will copy a printable error
      message string.

  buflen
      Specifies the size in bytes of the memory region addressed by the buf
      parameter.

DESCRIPTION
  The st_strerror() function translates a libst error code to a printable
  error message and copies that error message to the memory region addressed
  by the buf parameter. If the error message exceeds the size, in bytes, of
  the memory region specified by the buflen parameter, st_strerror() will
  truncate the error message.

  The error codes recognized and translated by the st_strerror() function are
  defined in /usr/include/st.h.

RETURN VALUES
  All functions indicate success by returning a value of 0 (zero). A positive
  return value is an errno value from a system call. A negative return value
  is a library error or informational code. The library codes are documented
  in st.h.

EXAMPLE
  This code fragment illustrates how to use st_strerror() to report an error
  returned by a libst routine.

       #include <st.h>

       ...

       st_obj_t	     *obj;
       st_status_t   status;
       char	     *objname
       char	     errmsg[128];

       ...

       if (status = st_obj_open(&obj, objname, ST_RDWR)) {
	     st_strerror(status, errmsg, sizeof(errmsg));
	     fprintf(stderr, "st_obj_open failure: %s\n", errmsg);
	     exit(1);
       }

       ...

FILES
  /usr/include/st.h
      Header file that contains definitions (including error codes) and
      function prototypes for libst.a functions

SEE ALSO
  Functions: libst_intro(3), st_obj_open(3)

Index for Section 3

Alphabetical listing for S

Top of page