/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSError.html is in gnustep-base-doc 1.24.7-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSError class documentation</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSError">NSError class documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 2004,2006 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSError class
</a></h1>
<h2><a name="class$NSError">NSError</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSError.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCopying)">NSCopying</a></dd>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCoding)">NSCoding</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Error information class. <br /> NSError instances are
used to pass information about runtime errors from lower
levels to higher levels of the program. <br /> These
should be used instead of exceptions where an error is
caused by external factors (such as a resource file
not being present) rather than a programming error (where
NSException should be used).
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSError.html#method$NSError+errorWithDomain$code$userInfo$">+errorWithDomain:code:userInfo:</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-code">-code</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-domain">-domain</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-initWithDomain$code$userInfo$">-initWithDomain:code:userInfo:</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-localizedDescription">-localizedDescription</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-localizedFailureReason">-localizedFailureReason</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-localizedRecoveryOptions">-localizedRecoveryOptions</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-localizedRecoverySuggestion">-localizedRecoverySuggestion</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-recoveryAttempter">-recoveryAttempter</a></li>
<li><a rel="gsdoc" href="NSError.html#method$NSError-userInfo">-userInfo</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSError+errorWithDomain$code$userInfo$">errorWithDomain: code: userInfo: </a></h3>
+ (id) <b>errorWithDomain:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aDomain<b> code:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)aCode<b> userInfo:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)aDictionary;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Creates and returns an autoreleased NSError
instance by calling
<a rel="gsdoc" href="#method$NSError-initWithDomain$code$userInfo$">
-initWithDomain:code:userInfo:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-code">code </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>code</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Return the error code... which is not globally
unique, just unique for a particular domain.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-domain">domain </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>domain</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Return the domain for this instance.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-initWithDomain$code$userInfo$">initWithDomain: code: userInfo: </a></h3>
- (id) <b>initWithDomain:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aDomain<b> code:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)aCode<b> userInfo:</b> (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*)aDictionary;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialises the receiver using the supplied
domain, code, and info. <br /> The domain must be
non-nil.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-localizedDescription">localizedDescription </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>localizedDescription</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Return a human readable description for the error.
<br /> The default implementation uses the value
from the user info dictionary if it is available,
otherwise it generates a generic one from domain
and code.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-localizedFailureReason">localizedFailureReason </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>localizedFailureReason</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Return a human readable explanation of the reason
for the error (if known). This should normally be a
more discursive explanation then the
<strong>short</strong> one provided by the
<a rel="gsdoc" href="#method$NSError-localizedDescription">
-localizedDescription
</a>
method. <br /> The default implementation uses the
value from the user info dictionary if it is
available, otherwise it returns <code>nil</code>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-localizedRecoveryOptions">localizedRecoveryOptions </a></h3>
- (<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>*) <b>localizedRecoveryOptions</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Returns an array of strings to be used as titles of
buttons in an alert panel when offering the user
optionbs to try to recover from the error. <br />
The default implementation uses the value from the user
info dictionary if it is available, otherwise it
returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-localizedRecoverySuggestion">localizedRecoverySuggestion </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>localizedRecoverySuggestion</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Returns a string used as the secondary text in an
alert panel, suggesting how the user might select an
option to attempt to recover from the error. <br />
The default implementation uses the value from the user
info dictionary if it is available, otherwise it
returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-recoveryAttempter">recoveryAttempter </a></h3>
- (id) <b>recoveryAttempter</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Not yet useful in GNUstep. <br /> The default
implementation uses the value from the user
info dictionary if it is available, otherwise it
returns <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSError-userInfo">userInfo </a></h3>
- (<a rel="gsdoc" href="NSDictionary.html#class$NSDictionary">NSDictionary</a>*) <b>userInfo</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.3.0</div>
<br />
<div class="desc">
Return the user info for this instance (or
<code>nil</code> if none is set) <br /> The
<code>NSLocalizedDescriptionKey</code> should locate
a human readable description in the dictionary. <br />
The <code>NSUnderlyingErrorKey</code> key should locate
an <code>NSError</code> instance if an error is
available describing any underlying problem.
<br />
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|