usr/src/man/man3exacct/ea_error.3exacct

   1 '\" te
   2 .\" Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH EA_ERROR 3EXACCT "Nov 29, 2001"
   7 .SH NAME
   8 ea_error \- error interface to extended accounting library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lexacct\fR [ \fIlibrary \fR\&.\|.\|. ]
  13 #include <exacct.h>
  14
  15 \fBint\fR \fBea_error\fR(\fBvoid\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBea_error()\fR function returns the error value of the last failure
  22 recorded by the invocation of one of the functions of the extended accounting
  23 library, \fBlibexacct\fR.
  24 .SH RETURN VALUES
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fBEXR_CORRUPT_FILE\fR\fR
  29 .ad
  30 .RS 20n
  31 A function failed because the file was not a valid exacct file.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBEXR_EOF\fR\fR
  38 .ad
  39 .RS 20n
  40 A function detected the end of the file, either when reading forwards or
  41 backwards through the file.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBEXR_INVALID_BUF\fR\fR
  48 .ad
  49 .RS 20n
  50 When unpacking an object, an invalid unpack buffer was specified.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBEXR_INVALID_OBJ\fR\fR
  57 .ad
  58 .RS 20n
  59 The object type passed to the function is not valid for the requested
  60 operation, for example passing a group object to \fBea_set_item\fR(3EXACCT).
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBEXR_NO_CREATOR\fR\fR
  67 .ad
  68 .RS 20n
  69 When creating a new file no creator was specified, or when opening a file for
  70 reading the creator value did not match the value in the file.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBEXR_NOTSUPP\fR\fR
  77 .ad
  78 .RS 20n
  79 An unsupported type of access was attempted, for example attempting to write to
  80 a file that was opened read-only.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBEXR_OK\fR\fR
  87 .ad
  88 .RS 20n
  89 The function completed successfully.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBEXR_SYSCALL_FAIL\fR\fR
  96 .ad
  97 .RS 20n
  98 A system call invoked  by  the  function  failed.  The \fBerrno\fR  variable
  99 contains  the  error value set by the underlying call.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBEXR_UNKN_VERSION\fR\fR
 106 .ad
 107 .RS 20n
 108 The file referred to by name uses an \fBexacct\fR file version that cannot be
 109 processed by this library.
 110 .RE
 111
 112 .SH ATTRIBUTES
 113 .sp
 114 .LP
 115 See \fBattributes\fR(7) for descriptions of the following attributes:
 116 .sp
 117
 118 .sp
 119 .TS
 120 box;
 121 c | c
 122 l | l .
 123 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 124 _
 125 Interface Stability     Evolving
 126 _
 127 MT-Level        MT-Safe
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 .BR read (2),
 134 .BR libexacct (3LIB),
 135 .BR attributes (7)