usr/src/man/man3pool/pool_error.3pool

   1 '\" te
   2 .\" Copyright (c) 2003, 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 POOL_ERROR 3POOL "Sep 23, 2003"
   7 .SH NAME
   8 pool_error, pool_strerror \- error interface to resource pools library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpool\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <pool.h>
  14
  15 \fBint\fR \fBpool_error\fR(\fBvoid\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBconst char *\fR\fBpool_strerror\fR(\fBint\fR \fIperr\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBpool_error()\fR function returns the error value of the last failure
  27 recorded by the invocation of one of the functions of the resource pool
  28 configuration library, \fBlibpool\fR.
  29 .sp
  30 .LP
  31 The \fBpool_strerror()\fR function returns a descriptive null-terminated string
  32 for each of the valid pool error codes.
  33 .sp
  34 .LP
  35 The following error codes can be returned by \fBpool_error()\fR:
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 The \fBpool_error()\fR function returns the current pool error value for the
  40 calling thread from among the following:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBPOE_ACCESS\fR\fR
  45 .ad
  46 .RS 22n
  47 The operation could not be performed because the configuration was not opened
  48 with the correct opening permissions.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBPOE_BADPARAM\fR\fR
  55 .ad
  56 .RS 22n
  57 A bad parameter was supplied.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBPOE_BAD_PROP_TYPE\fR\fR
  64 .ad
  65 .RS 22n
  66 An incorrect property type was submitted or encountered during the pool
  67 operation.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBPOE_DATASTORE\fR\fR
  74 .ad
  75 .RS 22n
  76 An error occurred within permanent storage.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBPOE_INVALID_CONF\fR\fR
  83 .ad
  84 .RS 22n
  85 The pool configuration presented for the operation is invalid.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBPOE_INVALID_SEARCH\fR\fR
  92 .ad
  93 .RS 22n
  94 A query whose outcome set was empty was attempted.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBPOE_NOTSUP\fR\fR
 101 .ad
 102 .RS 22n
 103 An unsupported operation was attempted.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBPOE_PUTPROP\fR\fR
 110 .ad
 111 .RS 22n
 112 An attempt to write a read-only property was made.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBPOE_OK\fR\fR
 119 .ad
 120 .RS 22n
 121 The previous pool operation succeeded.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBPOE_SYSTEM\fR\fR
 128 .ad
 129 .RS 22n
 130 An underlying system call or library function failed; \fBerrno\fR(3C) is
 131 preserved where possible.
 132 .RE
 133
 134 .sp
 135 .LP
 136 The \fBpool_strerror()\fR function returns a pointer to the string
 137 corresponding to the requested error value. If the error value has no
 138 corresponding string, \(mi1 is returned and \fBerrno\fR is set to indicate the
 139 error.
 140 .SH ERRORS
 141 .sp
 142 .LP
 143 The \fBpool_strerror()\fR function will fail if:
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBESRCH\fR\fR
 148 .ad
 149 .RS 9n
 150 The specified error value is not defined by the pools error facility.
 151 .RE
 152
 153 .SH ATTRIBUTES
 154 .sp
 155 .LP
 156 See \fBattributes\fR(5) for descriptions of the following attributes:
 157 .sp
 158
 159 .sp
 160 .TS
 161 box;
 162 c | c
 163 l | l .
 164 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 165 _
 166 CSI     Enabled
 167 _
 168 Interface Stability     Unstable
 169 _
 170 MT-Level        Safe
 171 .TE
 172
 173 .SH SEE ALSO
 174 .sp
 175 .LP
 176 \fBerrno\fR(3C), \fBlibpool\fR(3LIB), pool_error(3POOL), \fBattributes\fR(5)