Security/utilities/src/SecCFError.h

   1 /*
   2  * Copyright (c) 2012-2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 #ifndef _SECCFERROR_H_
  26 #define _SECCFERROR_H_
  27
  28 #include <CoreFoundation/CoreFoundation.h>
  29
  30 //
  31 // Leaf error creation from other systems
  32 //
  33
  34 // kern_return_t errors
  35 #define kSecKernDomain  kCFErrorDomainMach
  36 bool SecKernError(kern_return_t result, CFErrorRef *error, CFStringRef format, ...);
  37
  38 // Unix errno errors
  39 #define kSecErrnoDomain  kCFErrorDomainPOSIX
  40 bool SecCheckErrno(int result, CFErrorRef *error, CFStringRef format, ...);
  41
  42 // OSStatus errors
  43 #define kSecErrorDomain  kCFErrorDomainOSStatus
  44 bool SecError(OSStatus status, CFErrorRef *error, CFStringRef format, ...);
  45
  46 //
  47 // Create and chain, all return false to make the analyzer happy.
  48 //
  49 bool SecCFCreateError(CFIndex errorCode, CFStringRef domain, CFStringRef descriptionString,
  50                       CFErrorRef previousError, CFErrorRef *newError);
  51
  52 bool SecCFCreateErrorWithFormat(CFIndex errorCode, CFStringRef domain, CFErrorRef previousError, CFErrorRef *newError,
  53                                 CFDictionaryRef formatoptions, CFStringRef descriptionString, ...)
  54                         CF_FORMAT_FUNCTION(6,7);
  55
  56
  57 bool SecCFCreateErrorWithFormatAndArguments(CFIndex errorCode, CFStringRef domain,
  58                                             CFErrorRef previousError, CFErrorRef *newError,
  59                                             CFDictionaryRef formatoptions, CFStringRef descriptionString, va_list args)
  60                                 CF_FORMAT_FUNCTION(6, 0);
  61
  62 #endif