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/NSValue.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>NSValue class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSValue">NSValue class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Adam Fedor (<a href="mailto:fedor@boulder.colorado.edu"><code>fedor@boulder.colorado.edu</code></a>)</dt>
<dd>
</dd>
<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)
1993, 1994, 1996, 1999 Free Software Foundation, Inc.
</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSNumber class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSValue class</a>
</li>
<li>
<a href="#003000000000">Software documentation for the NSValue(Subclassing)
category</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSNumber class
</a></h1>
<h2><a name="class$NSNumber">NSNumber</a> : <a rel="gsdoc" href="#class$NSValue">NSValue</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSValue.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> OpenStep</div>
<br />
<div class="desc">
Subclass of
<a rel="gsdoc" href="#class$NSValue">NSValue</a>
offering convenience methods for initializing from
and accessing as any C primitive numeric type. On
access, the value will be type-converted if
necessary, using standard C conversion rules.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSDecimalNumber.html#method$NSNumber(NSDecimalNumber)-decimalValue">-decimalValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithBool$">+numberWithBool:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithChar$">+numberWithChar:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithDouble$">+numberWithDouble:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithFloat$">+numberWithFloat:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithInt$">+numberWithInt:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithInteger$">+numberWithInteger:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithLong$">+numberWithLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithLongLong$">+numberWithLongLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithShort$">+numberWithShort:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedChar$">+numberWithUnsignedChar:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedInt$">+numberWithUnsignedInt:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedInteger$">+numberWithUnsignedInteger:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedLong$">+numberWithUnsignedLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedLongLong$">+numberWithUnsignedLongLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber+numberWithUnsignedShort$">+numberWithUnsignedShort:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-boolValue">-boolValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-charValue">-charValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-compare$">-compare:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-description">-description</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-descriptionWithLocale$">-descriptionWithLocale:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-doubleValue">-doubleValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-floatValue">-floatValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithBool$">-initWithBool:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithChar$">-initWithChar:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithDouble$">-initWithDouble:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithFloat$">-initWithFloat:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithInt$">-initWithInt:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithInteger$">-initWithInteger:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithLong$">-initWithLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithLongLong$">-initWithLongLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithShort$">-initWithShort:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedChar$">-initWithUnsignedChar:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedInt$">-initWithUnsignedInt:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedInteger$">-initWithUnsignedInteger:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedLong$">-initWithUnsignedLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedLongLong$">-initWithUnsignedLongLong:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-initWithUnsignedShort$">-initWithUnsignedShort:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-intValue">-intValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-integerValue">-integerValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-isEqualToNumber$">-isEqualToNumber:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-longLongValue">-longLongValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-longValue">-longValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-shortValue">-shortValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-stringValue">-stringValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedCharValue">-unsignedCharValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedIntValue">-unsignedIntValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedIntegerValue">-unsignedIntegerValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedLongLongValue">-unsignedLongLongValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedLongValue">-unsignedLongValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSNumber-unsignedShortValue">-unsignedShortValue</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSNumber+numberWithBool$">numberWithBool: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithBool:</b> (BOOL)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from boolean <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithChar$">numberWithChar: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithChar:</b> (signed char)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>signed</strong>
<strong>char</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithDouble$">numberWithDouble: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithDouble:</b> (double)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>double</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithFloat$">numberWithFloat: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithFloat:</b> (float)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>float</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithInt$">numberWithInt: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithInt:</b> (signed int)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from (<strong>signed</strong>)
<strong>int</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithInteger$">numberWithInteger: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)value;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Return a number intialised with NSInteger.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithLong$">numberWithLong: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithLong:</b> (signed long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from (<strong>signed</strong>)
<strong>long</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithLongLong$">numberWithLongLong: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithLongLong:</b> (signed long long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from (<strong>signed</strong>)
<strong>long</strong> <strong>long</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithShort$">numberWithShort: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithShort:</b> (signed short)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from (<strong>signed</strong>)
<strong>short</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedChar$">numberWithUnsignedChar: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedChar:</b> (unsigned char)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>unsigned</strong>
<strong>char</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedInt$">numberWithUnsignedInt: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedInt:</b> (unsigned int)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>unsigned</strong>
<strong>int</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedInteger$">numberWithUnsignedInteger: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)value;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Return a number intialised with NSUInteger.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedLong$">numberWithUnsignedLong: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedLong:</b> (unsigned long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>unsigned</strong>
<strong>long</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedLongLong$">numberWithUnsignedLongLong: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedLongLong:</b> (unsigned long long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>unsigned</strong>
<strong>long</strong> <strong>long</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber+numberWithUnsignedShort$">numberWithUnsignedShort: </a></h3>
+ (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*) <b>numberWithUnsignedShort:</b> (unsigned short)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
New instance from <strong>unsigned</strong>
<strong>short</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-boolValue">boolValue </a></h3>
- (BOOL) <b>boolValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return value as a BOOL; this will in fact be a
<strong>char</strong> value converted if necessary
from type initialized with; if you wish to consider
anything nonzero TRUE do not compare directly to
<code>YES</code>, but use <code>'!= NO'</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-charValue">charValue </a></h3>
- (signed char) <b>charValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a <strong>signed</strong>
<strong>char</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-compare$">compare: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSComparisonResult">NSComparisonResult</a>) <b>compare:</b> (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*)otherNumber;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Compares receiver with <var>otherNumber</var>,
using C type conversion if necessary, and returns
<code>NSOrderedAscending</code>,
<code>NSOrderedDescending</code>, or
<code>NSOrderedSame</code> depending on whether it
is less than, greater than, or equal to
<var>otherNumber</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-description">description </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>description</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the string representation of this number
using a non-localised conversion (decimal point is
'.' irrespective of the locale).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-descriptionWithLocale$">descriptionWithLocale: </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>descriptionWithLocale:</b> (id)locale;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Produces a string representation of the number.
For a boolean this will be either 'true' or 'false'.
For other numbers the format is produced using the
initWithFormat:locale:...
method of NSString, and the format depends on the
type of number as follows -
</p>
<p>
<dl>
<dt><strong>char</strong></dt>
<dd>
%i
</dd>
<dt><strong>short</strong></dt>
<dd>
%hi
</dd>
<dt><strong>int</strong></dt>
<dd>
%i
</dd>
<dt><strong>long</strong></dt>
<dd>
%li
</dd>
<dt>
<strong>long</strong> <strong>long</strong>
</dt>
<dd>
%lli
</dd>
<dt>
<strong>unsigned</strong>
<strong>char</strong>
</dt>
<dd>
%u
</dd>
<dt>
<strong>unsigned</strong>
<strong>short</strong>
</dt>
<dd>
%hu
</dd>
<dt>
<strong>unsigned</strong> <strong>int</strong>
</dt>
<dd>
%u
</dd>
<dt>
<strong>unsigned</strong>
<strong>long</strong>
</dt>
<dd>
%lu
</dd>
<dt>
<strong>unsigned</strong>
<strong>long</strong> <strong>long</strong>
</dt>
<dd>
%llu
</dd>
<dt><strong>float</strong></dt>
<dd>
%0.7g
</dd>
<dt><strong>double</strong></dt>
<dd>
%0.16g
</dd>
</dl>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-doubleValue">doubleValue </a></h3>
- (double) <b>doubleValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a <strong>double</strong>,
converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-floatValue">floatValue </a></h3>
- (float) <b>floatValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a <strong>float</strong>,
converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithBool$">initWithBool: </a></h3>
- (id) <b>initWithBool:</b> (BOOL)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from boolean <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithChar$">initWithChar: </a></h3>
- (id) <b>initWithChar:</b> (signed char)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>signed</strong>
<strong>char</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithDouble$">initWithDouble: </a></h3>
- (id) <b>initWithDouble:</b> (double)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>double</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithFloat$">initWithFloat: </a></h3>
- (id) <b>initWithFloat:</b> (float)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>float</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithInt$">initWithInt: </a></h3>
- (id) <b>initWithInt:</b> (signed int)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from (<strong>signed</strong>)
<strong>int</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithInteger$">initWithInteger: </a></h3>
- (id) <b>initWithInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)value;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Initialise the receiver with NSInteger content.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithLong$">initWithLong: </a></h3>
- (id) <b>initWithLong:</b> (signed long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from (<strong>signed</strong>)
<strong>long</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithLongLong$">initWithLongLong: </a></h3>
- (id) <b>initWithLongLong:</b> (signed long long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from (<strong>signed</strong>)
<strong>long</strong> <strong>long</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithShort$">initWithShort: </a></h3>
- (id) <b>initWithShort:</b> (signed short)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from (<strong>signed</strong>)
<strong>short</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedChar$">initWithUnsignedChar: </a></h3>
- (id) <b>initWithUnsignedChar:</b> (unsigned char)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>unsigned</strong>
<strong>char</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedInt$">initWithUnsignedInt: </a></h3>
- (id) <b>initWithUnsignedInt:</b> (unsigned int)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>unsigned</strong>
<strong>int</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedInteger$">initWithUnsignedInteger: </a></h3>
- (id) <b>initWithUnsignedInteger:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)value;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Initialise the receiver with NSUInteger content.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedLong$">initWithUnsignedLong: </a></h3>
- (id) <b>initWithUnsignedLong:</b> (unsigned long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>unsigned</strong>
<strong>long</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedLongLong$">initWithUnsignedLongLong: </a></h3>
- (id) <b>initWithUnsignedLongLong:</b> (unsigned long long)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>unsigned</strong>
<strong>long</strong> <strong>long</strong>
<var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-initWithUnsignedShort$">initWithUnsignedShort: </a></h3>
- (id) <b>initWithUnsignedShort:</b> (unsigned short)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize from <strong>unsigned</strong>
<strong>short</strong> <var>value</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-intValue">intValue </a></h3>
- (signed int) <b>intValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a (<strong>signed</strong>)
<strong>int</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-integerValue">integerValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>integerValue</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Return the contents of the receiver as NSInteger.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-isEqualToNumber$">isEqualToNumber: </a></h3>
- (BOOL) <b>isEqualToNumber:</b> (<a rel="gsdoc" href="#class$NSNumber">NSNumber</a>*)otherNumber;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns whether receiver and <var>otherNumber</var>
represent the same numerical value.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-longLongValue">longLongValue </a></h3>
- (signed long long) <b>longLongValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a (<strong>signed</strong>)
<strong>long</strong> <strong>long</strong>,
converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-longValue">longValue </a></h3>
- (signed long) <b>longValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a (<strong>signed</strong>)
<strong>long</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-shortValue">shortValue </a></h3>
- (signed short) <b>shortValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as a (<strong>signed</strong>)
<strong>short</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-stringValue">stringValue </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>stringValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns
<a rel="gsdoc" href="#method$NSNumber-description">
-description
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedCharValue">unsignedCharValue </a></h3>
- (unsigned char) <b>unsignedCharValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as an <strong>unsigned</strong>
<strong>char</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedIntValue">unsignedIntValue </a></h3>
- (unsigned int) <b>unsignedIntValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as an <strong>unsigned</strong>
<strong>int</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedIntegerValue">unsignedIntegerValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>unsignedIntegerValue</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.5.0</div>
<br />
<div class="desc">
Return the contents of the receiver as NSUInteger.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedLongLongValue">unsignedLongLongValue </a></h3>
- (unsigned long long) <b>unsignedLongLongValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as an <strong>unsigned</strong>
<strong>long</strong> <strong>long</strong>,
converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedLongValue">unsignedLongValue </a></h3>
- (unsigned long) <b>unsignedLongValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as an <strong>unsigned</strong>
<strong>long</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSNumber-unsignedShortValue">unsignedShortValue </a></h3>
- (unsigned short) <b>unsignedShortValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns value as an <strong>unsigned</strong>
<strong>short</strong>, converting if necessary.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="002000000000">
Software documentation for the NSValue class
</a></h1>
<h2><a name="class$NSValue">NSValue</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSValue.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> OpenStep</div>
<br />
<div class="desc">
The <code>NSValue</code> class can wrap a single
primitive value as an object so it can be used in
the containers and other places where an object reference
is needed. Once initialized, an <code>NSValue</code> is
immutable, and there is no
<code>NSMutableValue</code> class. You initialize it
by giving it a pointer to the primitive value, and you
should be careful this does not get freed until after
the <code>NSValue</code> is no longer used.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue(Subclassing)+valueClassWithObjCType$">+valueClassWithObjCType:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+value$withObjCType$">+value:withObjCType:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithBytes$objCType$">+valueWithBytes:objCType:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithNonretainedObject$">+valueWithNonretainedObject:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithPoint$">+valueWithPoint:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithPointer$">+valueWithPointer:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithRange$">+valueWithRange:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithRect$">+valueWithRect:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue+valueWithSize$">+valueWithSize:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-getValue$">-getValue:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-initWithBytes$objCType$">-initWithBytes:objCType:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-isEqualToValue$">-isEqualToValue:</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-nonretainedObjectValue">-nonretainedObjectValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-objCType">-objCType</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-pointValue">-pointValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-pointerValue">-pointerValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-rangeValue">-rangeValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-rectValue">-rectValue</a></li>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue-sizeValue">-sizeValue</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSValue+value$withObjCType$">value: withObjCType: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>value:</b> (const void*)value<b> withObjCType:</b> (const char*)type;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Create new instance with specified <var>value</var>
(a pointer) of given <var>type</var>, which is a string
code obtainable through the compile-time operator
<code>@encode(...)</code>. For example:
<pre>
NSValue *theValue = [NSValue value: &n withObjCType: @encode(int)];
</pre>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithBytes$objCType$">valueWithBytes: objCType: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithBytes:</b> (const void*)value<b> objCType:</b> (const char*)type;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Synonym for value:withObjCType:.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithNonretainedObject$">valueWithNonretainedObject: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithNonretainedObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Create new instance holding <var>anObject</var>.
This is useful if you want to add <var>anObject</var>
to a collection such as
<a rel="gsdoc" href="NSArray.html#class$NSArray">NSArray</a>
but don't want it to be retained (a weak reference).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithPoint$">valueWithPoint: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithPoint:</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">
Convenience method to create instance holding
an <code>NSPoint</code> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithPointer$">valueWithPointer: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithPointer:</b> (const void*)pointer;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Convenience method to create instance holding a
<var>pointer</var>. Same as using
<code>@encode(<strong>void</strong> *)</code> in
<a rel="gsdoc" href="#method$NSValue+value$withObjCType$">
+value:withObjCType:
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithRange$">valueWithRange: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)range;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Convenience method to create instance holding
an <code>NSRange</code> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithRect$">valueWithRect: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithRect:</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">
Convenience method to create instance holding
an <code>NSRect</code> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue+valueWithSize$">valueWithSize: </a></h3>
+ (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*) <b>valueWithSize:</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">
Convenience method to create instance holding
an <code>NSSize</code> structure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-getValue$">getValue: </a></h3>
- (void) <b>getValue:</b> (void*)value;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Copies bytes from the pointer receiver was
initialized with into buffer pointed to by
<var>value</var>. Number of bytes copied is
determined by the type. If type was a
<strong>void</strong> * pointer or object
<strong>id</strong>, the memory address itself is
copied.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-initWithBytes$objCType$">initWithBytes: objCType: </a></h3>
- (id) <b>initWithBytes:</b> (const void*)data<b> objCType:</b> (const char*)type;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
This is a designated initialiser for the class.<br />
<div class="desc">
Initialize with value of <var>type</var>,
parallel to value:withObjCType:.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-isEqualToValue$">isEqualToValue: </a></h3>
- (BOOL) <b>isEqualToValue:</b> (<a rel="gsdoc" href="#class$NSValue">NSValue</a>*)other;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Compares this instance to another
<code>NSValue</code>. For equality, both contents
and declared type of the two values must match.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-nonretainedObjectValue">nonretainedObjectValue </a></h3>
- (id) <b>nonretainedObjectValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with an object ID, return
it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-objCType">objCType </a></h3>
- (const char*) <b>objCType</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the string <code>@encode(...)</code>
compatible type the receiver was initialized
with.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-pointValue">pointValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSPoint">NSPoint</a>) <b>pointValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with an <code>NSPoint</code>
value, return it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-pointerValue">pointerValue </a></h3>
- (void*) <b>pointerValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with a <strong>void</strong>
* pointer, return it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-rangeValue">rangeValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>) <b>rangeValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with an <code>NSRange</code>
value, return it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-rectValue">rectValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRect">NSRect</a>) <b>rectValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with an <code>NSRect</code>
value, return it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSValue-sizeValue">sizeValue </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSSize">NSSize</a>) <b>sizeValue</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
If receiver was initialized with an <code>NSSize</code>
value, return it, else raises
<code>NSInternalInconsistencyException</code>.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="003000000000">
Software documentation for the NSValue(Subclassing)
category
</a></h1>
<h2><a rel="gsdoc" href="#class$NSValue">NSValue</a>(<a name="category$NSValue(Subclassing)">Subclassing</a>)</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSValue.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Note: Defines a method that is not in the OpenStep
spec, but makes subclassing easier.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSValue.html#method$NSValue(Subclassing)+valueClassWithObjCType$">+valueClassWithObjCType:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSValue(Subclassing)+valueClassWithObjCType$">valueClassWithObjCType: </a></h3>
+ (Class) <b>valueClassWithObjCType:</b> (const char*)type;<br />
<div class="availability">
<b>Availability:</b> Not in OpenStep/MacOS-X</div>
<br />
<div class="desc">
Used by value: withObjCType: to determine the concrete
subclass to alloc.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)