Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/share/doc/gnustep-base-doc/Base/Reference/
Upload File :
Current File : //usr/share/doc/gnustep-base-doc/Base/Reference/NSCoder.html
<!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>NSCoder class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSCoder">NSCoder class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Andrew Kachites McCallum (<a href="mailto:mccallum@gnu.ai.mit.edu"><code>mccallum@gnu.ai.mit.edu</code></a>)</dt>
<dd>
</dd>
<dt>Adam Fedor (<a href="mailto:fedor@boulder.colorado.edu"><code>fedor@boulder.colorado.edu</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1995, 1996 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSCoder class
</a></h1>
<h2><a name="class$NSCoder">NSCoder</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSCoder.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Top-level class defining methods for use when
archiving (encoding) objects to a byte array or
file, and when restoring (decoding) objects.
Generally only subclasses of this class are used
directly -
<a rel="gsdoc" href="NSArchiver.html#class$NSArchiver">NSArchiver</a>
,
<a rel="gsdoc" href="NSArchiver.html#class$NSUnarchiver">NSUnarchiver</a>
,
<a rel="gsdoc" href="NSKeyedArchiver.html#class$NSKeyedArchiver">NSKeyedArchiver</a>
,
<a rel="gsdoc" href="NSKeyedArchiver.html#class$NSKeyedUnarchiver">NSKeyedUnarchiver</a>
, or
<a rel="gsdoc" href="NSPortCoder.html#class$NSPortCoder">NSPortCoder</a>
. </p>
<p>
</p>
<p>
<code>NSPortCoder</code> is used within
the distributed objects framework. For
archiving to/from disk, the
<em>Keyed...</em> classes are preferred for
new implementations, since they provide
greater forward/backward compatibility in
the face of class changes.
</p>
<p>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-decodePointForKey$">-decodePointForKey:</a></li>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-decodeRectForKey$">-decodeRectForKey:</a></li>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-decodeSizeForKey$">-decodeSizeForKey:</a></li>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-encodePoint$forKey$">-encodePoint:forKey:</a></li>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-encodeRect$forKey$">-encodeRect:forKey:</a></li>
<li><a rel="gsdoc" href="NSKeyedArchiver.html#method$NSCoder(NSGeometryKeyedCoding)-encodeSize$forKey$">-encodeSize:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-allowsKeyedCoding">-allowsKeyedCoding</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-containsValueForKey$">-containsValueForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeArrayOfObjCType$count$at$">-decodeArrayOfObjCType:count:at:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeBoolForKey$">-decodeBoolForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeBytesForKey$returnedLength$">-decodeBytesForKey:returnedLength:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeBytesWithReturnedLength$">-decodeBytesWithReturnedLength:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeDataObject">-decodeDataObject</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeDoubleForKey$">-decodeDoubleForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeFloatForKey$">-decodeFloatForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeInt32ForKey$">-decodeInt32ForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeInt64ForKey$">-decodeInt64ForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeIntForKey$">-decodeIntForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeIntegerForKey$">-decodeIntegerForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeObject">-decodeObject</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeObjectForKey$">-decodeObjectForKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeObjectOfClass$forKey$">-decodeObjectOfClass:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeObjectOfClasses$forKey$">-decodeObjectOfClasses:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodePoint">-decodePoint</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodePropertyList">-decodePropertyList</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeRect">-decodeRect</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeSize">-decodeSize</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeValueOfObjCType$at$">-decodeValueOfObjCType:at:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-decodeValuesOfObjCTypes$,...">-decodeValuesOfObjCTypes:,...</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeArrayOfObjCType$count$at$">-encodeArrayOfObjCType:count:at:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeBool$forKey$">-encodeBool:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeBycopyObject$">-encodeBycopyObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeByrefObject$">-encodeByrefObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeBytes$length$">-encodeBytes:length:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeBytes$length$forKey$">-encodeBytes:length:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeConditionalObject$">-encodeConditionalObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeConditionalObject$forKey$">-encodeConditionalObject:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeDataObject$">-encodeDataObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeDouble$forKey$">-encodeDouble:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeFloat$forKey$">-encodeFloat:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeInt32$forKey$">-encodeInt32:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeInt64$forKey$">-encodeInt64:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeInt$forKey$">-encodeInt:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeInteger$forKey$">-encodeInteger:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeObject$">-encodeObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeObject$forKey$">-encodeObject:forKey:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodePoint$">-encodePoint:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodePropertyList$">-encodePropertyList:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeRect$">-encodeRect:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeRootObject$">-encodeRootObject:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeSize$">-encodeSize:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeValueOfObjCType$at$">-encodeValueOfObjCType:at:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-encodeValuesOfObjCTypes$,...">-encodeValuesOfObjCTypes:,...</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-objectZone">-objectZone</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-requiresSecureCoding">-requiresSecureCoding</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-setObjectZone$">-setObjectZone:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-setRequiresSecureCoding$">-setRequiresSecureCoding:</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-systemVersion">-systemVersion</a></li>
<li><a rel="gsdoc" href="NSCoder.html#method$NSCoder-versionForClassName$">-versionForClassName:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSCoder-allowsKeyedCoding">allowsKeyedCoding </a></h3>
- (BOOL) <b>allowsKeyedCoding</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a flag indicating whether the receiver
supported keyed coding. the default
implementation returns <code>NO</code>.
Subclasses supporting keyed coding must override
this to return <code>YES</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-containsValueForKey$">containsValueForKey: </a></h3>
- (BOOL) <b>containsValueForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a class indicating whether an encoded value
corresponding to <var>aKey</var> exists.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeArrayOfObjCType$count$at$">decodeArrayOfObjCType: count: at: </a></h3>
- (void) <b>decodeArrayOfObjCType:</b> (const char*)type<b> count:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)count<b> at:</b> (void*)address;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes array of <var>count</var> structures or
objects of given <var>type</var>, which may be
obtained through the ' <code>@encode(...)</code> '
compile-time operator. Usually this is used
for primitives though it can be used for objects as
well. Objects will be retained and you must release
them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeBoolForKey$">decodeBoolForKey: </a></h3>
- (BOOL) <b>decodeBoolForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a boolean value associated with
<var>aKey</var>. This value must previously have been
encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeBool$forKey$">
-encodeBool:forKey:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeBytesForKey$returnedLength$">decodeBytesForKey: returnedLength: </a></h3>
- (const uint8_t*) <b>decodeBytesForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey<b> returnedLength:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>*)alength;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a pointer to a byte array associated with
<var>aKey</var>. <br /> Returns the length of the
data in aLength. <br /> This value must previously
have been encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeBytes$length$forKey$">
-encodeBytes:length:forKey:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeBytesWithReturnedLength$">decodeBytesWithReturnedLength: </a></h3>
- (void*) <b>decodeBytesWithReturnedLength:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>*)l;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Retrieve bytes directly from archive.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeDataObject">decodeDataObject </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>decodeDataObject</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decode an instance of
<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeDoubleForKey$">decodeDoubleForKey: </a></h3>
- (double) <b>decodeDoubleForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a <strong>double</strong> value associated
with <var>aKey</var>. This value must previously have
been encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeDouble$forKey$">
-encodeDouble:forKey:
</a>
or
<a rel="gsdoc" href="#method$NSCoder-encodeFloat$forKey$">
-encodeFloat:forKey:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeFloatForKey$">decodeFloatForKey: </a></h3>
- (float) <b>decodeFloatForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a <strong>float</strong> value associated
with <var>aKey</var>. This value must previously have
been encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeFloat$forKey$">
-encodeFloat:forKey:
</a>
or
<a rel="gsdoc" href="#method$NSCoder-encodeDouble$forKey$">
-encodeDouble:forKey:
</a>
<br /> Precision may be lost (or an exception raised
if the value will not fit in a <strong>float</strong>)
if the value was encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeDouble$forKey$">
-encodeDouble:forKey:
</a>
,
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeInt32ForKey$">decodeInt32ForKey: </a></h3>
- (int32_t) <b>decodeInt32ForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a 32-bit integer value associated with
<var>aKey</var>. This value must previously have been
encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeInt$forKey$">
-encodeInt:forKey:
</a>
,
<a rel="gsdoc" href="#method$NSCoder-encodeInt32$forKey$">
-encodeInt32:forKey:
</a>
, or
<a rel="gsdoc" href="#method$NSCoder-encodeInt64$forKey$">
-encodeInt64:forKey:
</a>
. <br /> An exception will be raised if the value does
not fit in a 32-bit integer.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeInt64ForKey$">decodeInt64ForKey: </a></h3>
- (int64_t) <b>decodeInt64ForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns a 64-bit integer value associated with
<var>aKey</var>. This value must previously have been
encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeInt$forKey$">
-encodeInt:forKey:
</a>
,
<a rel="gsdoc" href="#method$NSCoder-encodeInt32$forKey$">
-encodeInt32:forKey:
</a>
, or
<a rel="gsdoc" href="#method$NSCoder-encodeInt64$forKey$">
-encodeInt64:forKey:
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeIntForKey$">decodeIntForKey: </a></h3>
- (int) <b>decodeIntForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns an integer value associated with
<var>aKey</var>. This value must previously have been
encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeInt$forKey$">
-encodeInt:forKey:
</a>
,
<a rel="gsdoc" href="#method$NSCoder-encodeInt32$forKey$">
-encodeInt32:forKey:
</a>
, or
<a rel="gsdoc" href="#method$NSCoder-encodeInt64$forKey$">
-encodeInt64:forKey:
</a>
. <br /> An exception will be raised if the value does
not fit in an integer.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeIntegerForKey$">decodeIntegerForKey: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>decodeIntegerForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Decodes an NSInteger associated with the
<var>key</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeObject">decodeObject </a></h3>
- (id) <b>decodeObject</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes a generic object. Usually the class will be
read from the archive, an object will be created
through an <code>alloc</code> call, then that class
will be sent an
<a rel="gsdoc" href="NSObject.html#method$(NSCoding)-initWithCoder$">[<NSCoding>-initWithCoder:]</a>
message.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeObjectForKey$">decodeObjectForKey: </a></h3>
- (id) <b>decodeObjectForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns an object value associated with
<var>aKey</var>. This value must previously have been
encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeObject$forKey$">
-encodeObject:forKey:
</a>
or
<a rel="gsdoc" href="#method$NSCoder-encodeConditionalObject$forKey$">
-encodeConditionalObject:forKey:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeObjectOfClass$forKey$">decodeObjectOfClass: forKey: </a></h3>
- (id) <b>decodeObjectOfClass:</b> (Class)cls<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.8.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeObjectOfClasses$forKey$">decodeObjectOfClasses: forKey: </a></h3>
- (id) <b>decodeObjectOfClasses:</b> (<a rel="gsdoc" href="NSSet.html#class$NSSet">NSSet</a>*)classes<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.8.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodePoint">decodePoint </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSPoint">NSPoint</a>) <b>decodePoint</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes a point structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodePropertyList">decodePropertyList </a></h3>
- (id) <b>decodePropertyList</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes a property list from the archive previously
stored through a call to
<a rel="gsdoc" href="#method$NSCoder-encodePropertyList$">
-encodePropertyList:
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeRect">decodeRect </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRect">NSRect</a>) <b>decodeRect</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes a rectangle structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeSize">decodeSize </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSSize">NSSize</a>) <b>decodeSize</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes a size structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeValueOfObjCType$at$">decodeValueOfObjCType: at: </a></h3>
- (void) <b>decodeValueOfObjCType:</b> (const char*)type<b> at:</b> (void*)address;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Decodes structure or object of given
<var>type</var>, which may be obtained through the '
<code>@encode(...)</code> ' compile-time operator.
Usually this is used for primitives though it can
be used for objects as well, in which case you are
responsible for releasing them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-decodeValuesOfObjCTypes$,...">decodeValuesOfObjCTypes: ,...</a></h3>
- (void) <b>decodeValuesOfObjCTypes:</b> (const char*)types<b>,...</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Multiple version of
<a rel="gsdoc" href="#method$NSCoder-decodeValueOfObjCType$at$">
-decodeValueOfObjCType:at:
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeArrayOfObjCType$count$at$">encodeArrayOfObjCType: count: at: </a></h3>
- (void) <b>encodeArrayOfObjCType:</b> (const char*)type<b> count:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)count<b> at:</b> (const void*)array;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes <var>array</var> of <var>count</var>
structures or objects of given <var>type</var>,
which may be obtained through the '
<code>@encode(...)</code> ' compile-time operator.
Usually this is used for primitives though it can
be used for objects as well.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeBool$forKey$">encodeBool: forKey: </a></h3>
- (void) <b>encodeBool:</b> (BOOL)aBool<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes <var>aBool</var> and associates the encoded
value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeBycopyObject$">encodeBycopyObject: </a></h3>
- (void) <b>encodeBycopyObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Can be ignored.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeByrefObject$">encodeByrefObject: </a></h3>
- (void) <b>encodeByrefObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Can be ignored.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeBytes$length$">encodeBytes: length: </a></h3>
- (void) <b>encodeBytes:</b> (void*)d<b> length:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)l;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Stores bytes directly into archive.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeBytes$length$forKey$">encodeBytes: length: forKey: </a></h3>
- (void) <b>encodeBytes:</b> (const uint8_t*)aPointer<b> length:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)length<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes the data of the specified <var>length</var>
and pointed to by <var>aPointer</var>, and associates
the encoded value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeConditionalObject$">encodeConditionalObject: </a></h3>
- (void) <b>encodeConditionalObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encode object if it is/will be encoded
unconditionally by this coder, otherwise
store a <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeConditionalObject$forKey$">encodeConditionalObject: forKey: </a></h3>
- (void) <b>encodeConditionalObject:</b> (id)anObject<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes <var>anObject</var> and associates the
encoded value with <var>aKey</var>, but only if
<var>anObject</var> has already been encoded using
<a rel="gsdoc" href="#method$NSCoder-encodeObject$forKey$">
-encodeObject:forKey:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeDataObject$">encodeDataObject: </a></h3>
- (void) <b>encodeDataObject:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)data;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encode an instance of
<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeDouble$forKey$">encodeDouble: forKey: </a></h3>
- (void) <b>encodeDouble:</b> (double)aDouble<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes <var>aDouble</var> and associates the
encoded value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeFloat$forKey$">encodeFloat: forKey: </a></h3>
- (void) <b>encodeFloat:</b> (float)aFloat<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes <var>aFloat</var> and associates the
encoded value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeInt32$forKey$">encodeInt32: forKey: </a></h3>
- (void) <b>encodeInt32:</b> (int32_t)anInteger<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes 32 bit integer and associates the encoded
value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeInt64$forKey$">encodeInt64: forKey: </a></h3>
- (void) <b>encodeInt64:</b> (int64_t)anInteger<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes a 64 bit integer and associates the encoded
value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeInt$forKey$">encodeInt: forKey: </a></h3>
- (void) <b>encodeInt:</b> (int)anInteger<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes an <strong>int</strong> and associates the
encoded value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeInteger$forKey$">encodeInteger: forKey: </a></h3>
- (void) <b>encodeInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)anInteger<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes an NSInteger and associates the encoded
value with <var>key</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeObject$">encodeObject: </a></h3>
- (void) <b>encodeObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes a generic object. This will usually result
in an
<a rel="gsdoc" href="NSObject.html#method$(NSCoding)-encodeWithCoder$">[<NSCoding>-encodeWithCoder:]</a>
message being sent to <var>anObject</var> so it can encode itself.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeObject$forKey$">encodeObject: forKey: </a></h3>
- (void) <b>encodeObject:</b> (id)anObject<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aKey;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Encodes <var>anObject</var> and associates the
encoded value with <var>aKey</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodePoint$">encodePoint: </a></h3>
- (void) <b>encodePoint:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSPoint">NSPoint</a>)point;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes a <var>point</var> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodePropertyList$">encodePropertyList: </a></h3>
- (void) <b>encodePropertyList:</b> (id)plist;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes a property list by calling [NSSerializer
-serializePropertyList:], then
encoding the resulting
<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>
object.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeRect$">encodeRect: </a></h3>
- (void) <b>encodeRect:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRect">NSRect</a>)rect;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes a rectangle structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeRootObject$">encodeRootObject: </a></h3>
- (void) <b>encodeRootObject:</b> (id)rootObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Store object and objects it refers to in archive
(i.e., complete object graph).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeSize$">encodeSize: </a></h3>
- (void) <b>encodeSize:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSSize">NSSize</a>)size;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes a <var>size</var> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeValueOfObjCType$at$">encodeValueOfObjCType: at: </a></h3>
- (void) <b>encodeValueOfObjCType:</b> (const char*)type<b> at:</b> (const void*)address;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Encodes structure or object of given
<var>type</var>, which may be obtained through the '
<code>@encode(...)</code> ' compile-time operator.
Usually this is used for primitives though it can
be used for objects as well.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-encodeValuesOfObjCTypes$,...">encodeValuesOfObjCTypes: ,...</a></h3>
- (void) <b>encodeValuesOfObjCTypes:</b> (const char*)types<b>,...</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Multiple version of
<a rel="gsdoc" href="#method$NSCoder-encodeValueOfObjCType$at$">
-encodeValueOfObjCType:at:
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-objectZone">objectZone </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSZone">NSZone</a>*) <b>objectZone</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns zone being used to allocate memory for
decoded objects.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-requiresSecureCoding">requiresSecureCoding </a></h3>
- (BOOL) <b>requiresSecureCoding</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.8.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-setObjectZone$">setObjectZone: </a></h3>
- (void) <b>setObjectZone:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSZone">NSZone</a>*)zone;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets <var>zone</var> to use for allocating memory for
decoded objects.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-setRequiresSecureCoding$">setRequiresSecureCoding: </a></h3>
- (void) <b>setRequiresSecureCoding:</b> (BOOL)secure;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.8.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-systemVersion">systemVersion </a></h3>
- (unsigned int) <b>systemVersion</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns *Step version, which is not the release
version, but a large number, by specification
<1000 for pre-OpenStep. This implementation
returns a number based on the GNUstep major, minor,
and subminor versions.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSCoder-versionForClassName$">versionForClassName: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>versionForClassName:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)className;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns current version of class (when encoding) or
version of decoded class (decoded). Version comes
from [NSObject -getVersion].
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)