| 1 | /* $Id: kErr.h 29 2009-07-01 20:30:29Z bird $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * kErr - Status Code API.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (c) 2006-2007 Knut St. Osmundsen <bird-kStuff-spamix@anduin.net>
|
|---|
| 8 | *
|
|---|
| 9 | * Permission is hereby granted, free of charge, to any person
|
|---|
| 10 | * obtaining a copy of this software and associated documentation
|
|---|
| 11 | * files (the "Software"), to deal in the Software without
|
|---|
| 12 | * restriction, including without limitation the rights to use,
|
|---|
| 13 | * copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|---|
| 14 | * copies of the Software, and to permit persons to whom the
|
|---|
| 15 | * Software is furnished to do so, subject to the following
|
|---|
| 16 | * conditions:
|
|---|
| 17 | *
|
|---|
| 18 | * The above copyright notice and this permission notice shall be
|
|---|
| 19 | * included in all copies or substantial portions of the Software.
|
|---|
| 20 | *
|
|---|
| 21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|---|
| 22 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|---|
| 23 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|---|
| 24 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|---|
| 25 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|---|
| 26 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|---|
| 27 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|---|
| 28 | * OTHER DEALINGS IN THE SOFTWARE.
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | #ifndef ___k_kErr_h___
|
|---|
| 32 | #define ___k_kErr_h___
|
|---|
| 33 |
|
|---|
| 34 | /** @defgroup grp_kErr kErr - Status Code API
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /** @def KERR_DECL
|
|---|
| 39 | * Declares a kRdr function according to build context.
|
|---|
| 40 | * @param type The return type.
|
|---|
| 41 | */
|
|---|
| 42 | #if defined(KERR_BUILDING_DYNAMIC)
|
|---|
| 43 | # define KERR_DECL(type) K_DECL_EXPORT(type)
|
|---|
| 44 | #elif defined(KRDR_BUILT_DYNAMIC)
|
|---|
| 45 | # define KERR_DECL(type) K_DECL_IMPORT(type)
|
|---|
| 46 | #else
|
|---|
| 47 | # define KERR_DECL(type) type
|
|---|
| 48 | #endif
|
|---|
| 49 |
|
|---|
| 50 | #ifdef __cplusplus
|
|---|
| 51 | extern "C" {
|
|---|
| 52 | #endif
|
|---|
| 53 |
|
|---|
| 54 | KERR_DECL(const char *) kErrName(int rc);
|
|---|
| 55 | KERR_DECL(int) kErrFromErrno(int);
|
|---|
| 56 | KERR_DECL(int) kErrFromOS2(unsigned long rcOs2);
|
|---|
| 57 | KERR_DECL(int) kErrFromNtStatus(long rcNtStatus);
|
|---|
| 58 | KERR_DECL(int) kErrFromMach(int rcMach);
|
|---|
| 59 | KERR_DECL(int) kErrFromDarwin(int rcDarwin);
|
|---|
| 60 |
|
|---|
| 61 | #ifdef __cplusplus
|
|---|
| 62 | }
|
|---|
| 63 | #endif
|
|---|
| 64 |
|
|---|
| 65 | /** @} */
|
|---|
| 66 |
|
|---|
| 67 | #endif
|
|---|
| 68 |
|
|---|
