Foundation/NSError.h

   1 /* Copyright (c) 2006-2007 Christopher J. W. Lloyd
   2
   3 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   4
   5 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
   6
   7 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
   8 #import <Foundation/NSObject.h>
   9
  10 @class NSDictionary, NSArray;
  11
  12 FOUNDATION_EXPORT NSString *const NSPOSIXErrorDomain;
  13 FOUNDATION_EXPORT NSString *const NSOSStatusErrorDomain;
  14 // temporary until we can map it
  15 FOUNDATION_EXPORT NSString *const NSWINSOCKErrorDomain;
  16 FOUNDATION_EXPORT NSString *const NSWin32ErrorDomain;
  17
  18 FOUNDATION_EXPORT NSString *const NSCocoaErrorDomain;
  19
  20 FOUNDATION_EXPORT NSString *const NSUnderlyingErrorKey;
  21 FOUNDATION_EXPORT NSString *const NSLocalizedDescriptionKey;
  22 FOUNDATION_EXPORT NSString *const NSLocalizedFailureReasonErrorKey;
  23 FOUNDATION_EXPORT NSString *const NSLocalizedRecoveryOptionsErrorKey;
  24 FOUNDATION_EXPORT NSString *const NSLocalizedRecoverySuggestionErrorKey;
  25 FOUNDATION_EXPORT NSString *const NSRecoveryAttempterErrorKey;
  26
  27 FOUNDATION_EXPORT NSString *const NSStringEncodingErrorKey;
  28 FOUNDATION_EXPORT NSString *const NSFilePathErrorKey;
  29 FOUNDATION_EXPORT NSString *const NSErrorFailingURLStringKey;
  30 FOUNDATION_EXPORT NSString *const NSURLErrorKey;
  31
  32 @interface NSError : NSObject <NSCoding, NSCopying> {
  33     NSString *_domain;
  34     NSInteger _code;
  35     NSDictionary *_userInfo;
  36 }
  37
  38 - initWithDomain:(NSString *)domain code:(NSInteger)code userInfo:(NSDictionary *)userInfo;
  39
  40 + errorWithDomain:(NSString *)domain code:(NSInteger)code userInfo:(NSDictionary *)userInfo;
  41
  42 - (NSString *)domain;
  43 - (NSInteger)code;
  44 - (NSDictionary *)userInfo;
  45
  46 - (NSString *)localizedDescription;
  47 - (NSString *)localizedFailureReason;
  48 - (NSArray *)localizedRecoveryOptions;
  49 - (NSString *)localizedRecoverySuggestion;
  50
  51 - recoveryAttempter;
  52
  53 @end
  54
  55 @interface NSObject (NSErrorRecoveryAttempting)
  56
  57 - (void)attemptRecoveryFromError:(NSError *)error optionIndex:(NSUInteger)recoveryOptionIndex delegate:(id)delegate didRecoverSelector:(SEL)didRecoverSelector contextInfo:(void *)info;
  58 - (BOOL)attemptRecoveryFromError:(NSError *)error optionIndex:(NSUInteger)recoveryOptionIndex;
  59
  60 @end