man/man3pool/pool_error.3pool

         te
 Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 POOL_ERROR 3POOL "Sep 23, 2003"
 NAME
pool_error, pool_strerror - error interface to resource pools library
 SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lpool [ library.\|.\|. ]
#include <pool.h>

int pool_error(void);


const char *pool_strerror(int perr);


 DESCRIPTION

The pool_error() function returns the error value of the last failure
recorded by the invocation of one of the functions of the resource pool
configuration library, libpool.

The pool_strerror() function returns a descriptive null-terminated string
for each of the valid pool error codes.

The following error codes can be returned by pool_error():
 RETURN VALUES

The pool_error() function returns the current pool error value for the
calling thread from among the following:
POE_ACCESS

The operation could not be performed because the configuration was not opened
with the correct opening permissions.


POE_BADPARAM

A bad parameter was supplied.


POE_BAD_PROP_TYPE

An incorrect property type was submitted or encountered during the pool
operation.


POE_DATASTORE

An error occurred within permanent storage.


POE_INVALID_CONF

The pool configuration presented for the operation is invalid.


POE_INVALID_SEARCH

A query whose outcome set was empty was attempted.


POE_NOTSUP

An unsupported operation was attempted.


POE_PUTPROP

An attempt to write a read-only property was made.


POE_OK

The previous pool operation succeeded.


POE_SYSTEM

An underlying system call or library function failed; errno(3C) is
preserved where possible.


The pool_strerror() function returns a pointer to the string
corresponding to the requested error value. If the error value has no
corresponding string, -1 is returned and errno is set to indicate the
error.
 ERRORS

The pool_strerror() function will fail if:
ESRCH

The specified error value is not defined by the pools error facility.


 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability Unstable
MT-Level Safe


 SEE ALSO

errno(3C), libpool(3LIB), pool_error(3POOL), attributes(5)