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/NSArray.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>NSArray class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSArray">NSArray 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>
<dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 1995-2015 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the NSArray class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the NSMutableArray class</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the NSArray class
</a></h1>
<h2><a name="class$NSArray">NSArray</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSArray.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCoding)">NSCoding</a></dd>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSCopying)">NSCopying</a></dd>
<dd><a rel="gsdoc" href="NSObject.html#protocol$(NSMutableCopying)">NSMutableCopying</a></dd>
<dd><a rel="gsdoc" href="NSEnumerator.html#protocol$(NSFastEnumeration)">NSFastEnumeration</a></dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
A simple, low overhead, ordered container for objects. All
the objects in the container are retained by it. The
container may not contain <code>nil</code> (though
it may contain
<a rel="gsdoc" href="NSNull.html#method$NSNull+null">
[NSNull +null]
</a>
).
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSKeyValueObserving.html#method$NSArray(NSKeyValueObserverRegistration)-addObserver$toObjectsAtIndexes$forKeyPath$options$context$">-addObserver:toObjectsAtIndexes:forKeyPath:options:context:</a></li>
<li><a rel="gsdoc" href="NSKeyValueObserving.html#method$NSArray(NSKeyValueObserverRegistration)-removeObserver$fromObjectsAtIndexes$forKeyPath$">-removeObserver:fromObjectsAtIndexes:forKeyPath:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+array">+array</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithArray$">+arrayWithArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithContentsOfFile$">+arrayWithContentsOfFile:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithContentsOfURL$">+arrayWithContentsOfURL:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithObject$">+arrayWithObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithObjects$,...">+arrayWithObjects:,...</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray+arrayWithObjects$count$">+arrayWithObjects:count:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-arrayByAddingObject$">-arrayByAddingObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-arrayByAddingObjectsFromArray$">-arrayByAddingObjectsFromArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-componentsJoinedByString$">-componentsJoinedByString:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-containsObject$">-containsObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-count">-count</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-description">-description</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-descriptionWithLocale$">-descriptionWithLocale:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-descriptionWithLocale$indent$">-descriptionWithLocale:indent:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-enumerateObjectsAtIndexes$options$usingBlock$">-enumerateObjectsAtIndexes:options:usingBlock:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-enumerateObjectsUsingBlock$">-enumerateObjectsUsingBlock:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-enumerateObjectsWithOptions$usingBlock$">-enumerateObjectsWithOptions:usingBlock:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-firstObject">-firstObject</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-firstObjectCommonWithArray$">-firstObjectCommonWithArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-getObjects$">-getObjects:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-getObjects$range$">-getObjects:range:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObject$">-indexOfObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObject$inRange$">-indexOfObject:inRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObject$inSortedRange$options$usingComparator$">-indexOfObject:inSortedRange:options:usingComparator:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObjectAtIndexes$options$passingTest$">-indexOfObjectAtIndexes:options:passingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObjectIdenticalTo$">-indexOfObjectIdenticalTo:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObjectIdenticalTo$inRange$">-indexOfObjectIdenticalTo:inRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObjectPassingTest$">-indexOfObjectPassingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexOfObjectWithOptions$passingTest$">-indexOfObjectWithOptions:passingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexesOfObjectsAtIndexes$options$passingTest$">-indexesOfObjectsAtIndexes:options:passingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexesOfObjectsPassingTest$">-indexesOfObjectsPassingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-indexesOfObjectsWithOptions$passingTest$">-indexesOfObjectsWithOptions:passingTest:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-init">-init</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithArray$">-initWithArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithArray$copyItems$">-initWithArray:copyItems:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithContentsOfFile$">-initWithContentsOfFile:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithContentsOfURL$">-initWithContentsOfURL:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithObjects$,...">-initWithObjects:,...</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-initWithObjects$count$">-initWithObjects:count:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-isEqualToArray$">-isEqualToArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-lastObject">-lastObject</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-makeObjectsPerform$">-makeObjectsPerform:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-makeObjectsPerform$withObject$">-makeObjectsPerform:withObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-makeObjectsPerformSelector$">-makeObjectsPerformSelector:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-makeObjectsPerformSelector$withObject$">-makeObjectsPerformSelector:withObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-objectAtIndex$">-objectAtIndex:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-objectAtIndexedSubscript$">-objectAtIndexedSubscript:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-objectEnumerator">-objectEnumerator</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-objectsAtIndexes$">-objectsAtIndexes:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-pathsMatchingExtensions$">-pathsMatchingExtensions:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-reverseObjectEnumerator">-reverseObjectEnumerator</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-setValue$forKey$">-setValue:forKey:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayHint">-sortedArrayHint</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayUsingComparator$">-sortedArrayUsingComparator:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayUsingFunction$context$">-sortedArrayUsingFunction:context:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayUsingFunction$context$hint$">-sortedArrayUsingFunction:context:hint:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayUsingSelector$">-sortedArrayUsingSelector:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-sortedArrayWithOptions$usingComparator$">-sortedArrayWithOptions:usingComparator:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-subarrayWithRange$">-subarrayWithRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-valueForKey$">-valueForKey:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-writeToFile$atomically$">-writeToFile:atomically:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSArray-writeToURL$atomically$">-writeToURL:atomically:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSArray+array">array </a></h3>
+ (instancetype) <b>array</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an empty autoreleased array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithArray$">arrayWithArray: </a></h3>
+ (instancetype) <b>arrayWithArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)array;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a new autoreleased NSArray instance
containing all the objects from <var>array</var>
, in the same order as the original.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithContentsOfFile$">arrayWithContentsOfFile: </a></h3>
+ (instancetype) <b>arrayWithContentsOfFile:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)file;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array based upon the
<var>file</var>. The new array is created using
<a rel="gsdoc" href="NSObject.html#method$NSObject+allocWithZone$">
[NSObject +allocWithZone:]
</a>
and initialised using the
<a rel="gsdoc" href="#method$NSArray-initWithContentsOfFile$">[NSArray -initWithContentsOfFile:]</a>
method. See the documentation for those methods for more detail.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithContentsOfURL$">arrayWithContentsOfURL: </a></h3>
+ (instancetype) <b>arrayWithContentsOfURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)aURL;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Returns an autoreleased array from the contents of
<var>aURL</var>. The new array is created using
<a rel="gsdoc" href="NSObject.html#method$NSObject+allocWithZone$">
[NSObject +allocWithZone:]
</a>
and initialised using the
<a rel="gsdoc" href="#method$NSArray-initWithContentsOfURL$">
-initWithContentsOfURL:
</a>
method. See the documentation for those methods for
more detail.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithObject$">arrayWithObject: </a></h3>
+ (instancetype) <b>arrayWithObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array containing
<var>anObject</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithObjects$,...">arrayWithObjects: ,...</a></h3>
+ (instancetype) <b>arrayWithObjects:</b> (id)firstObject<b>,...</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array containing the list
of objects, preserving order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray+arrayWithObjects$count$">arrayWithObjects: count: </a></h3>
+ (instancetype) <b>arrayWithObjects:</b> (const id[])objects<b> count:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)count;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array containing the
specified <var>objects</var>, preserving order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-arrayByAddingObject$">arrayByAddingObject: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>arrayByAddingObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array formed from the
contents of the receiver and adding
<var>anObject</var> as the last item.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-arrayByAddingObjectsFromArray$">arrayByAddingObjectsFromArray: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>arrayByAddingObjectsFromArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)anotherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a new array which is the concatenation of
self and otherArray (in this precise order).
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-componentsJoinedByString$">componentsJoinedByString: </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>componentsJoinedByString:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)separator;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a string formed by concatenating the
objects in the receiver, with the specified
<var>separator</var> string inserted between each
part.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-containsObject$">containsObject: </a></h3>
- (BOOL) <b>containsObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code> if <var>anObject</var>
belongs to self. No otherwise. <br /> The
[NSObject -isEqual:]
method of <var>anObject</var> is used to test for
equality.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-count">count </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>count</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns the number of elements contained in the
receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-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 result of invoking
<a rel="gsdoc" href="#method$NSArray-descriptionWithLocale$indent$">
-descriptionWithLocale:indent:
</a>
with a <code>nil</code> locale and zero indent.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-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">
Returns the result of invoking
<a rel="gsdoc" href="#method$NSArray-descriptionWithLocale$indent$">
-descriptionWithLocale:indent:
</a>
with a zero indent.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-descriptionWithLocale$indent$">descriptionWithLocale: indent: </a></h3>
- (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*) <b>descriptionWithLocale:</b> (id)locale<b> indent:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)level;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the receiver as a text property list in the
traditional format. <br /> See
<a rel="gsdoc" href="NSString.html#method$NSString-propertyList">
[NSString -propertyList]
</a>
for details. <br /> If <var>locale</var> is
<code>nil</code>, no formatting is done, otherwise
entries are formatted according to the
<var>locale</var>, and indented according to
<var>level</var>. <br /> Unless <var>locale</var> is
<code>nil</code>, a <var>level</var> of zero indents
items by four spaces, while a <var>level</var> of one
indents them by a tab. <br /> The items in the
property list string appear in the same order as
they appear in the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-enumerateObjectsAtIndexes$options$usingBlock$">enumerateObjectsAtIndexes: options: usingBlock: </a></h3>
- (void) <b>enumerateObjectsAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexSet<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> usingBlock:</b> (GSEnumeratorBlock)block;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Enumerate over the specified indexes in the
collection using the given <var>block</var>. The
first argument is the object and the second is the
index in the array. The final argument is a pointer
to a BOOL indicating whether the enumeration should
stop. Setting this to <code>YES</code> will interrupt
the enumeration. The <var>opts</var> argument is a
bitfield. Setting the NSNSEnumerationConcurrent
flag specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-enumerateObjectsUsingBlock$">enumerateObjectsUsingBlock: </a></h3>
- (void) <b>enumerateObjectsUsingBlock:</b> (GSEnumeratorBlock)aBlock;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Enumerate over the collection using the given
block. The first argument is the object and the
second is the index in the array. The final argument
is a pointer to a BOOL indicating whether the
enumeration should stop. Setting this to
<code>YES</code> will interrupt the enumeration.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-enumerateObjectsWithOptions$usingBlock$">enumerateObjectsWithOptions: usingBlock: </a></h3>
- (void) <b>enumerateObjectsWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> usingBlock:</b> (GSEnumeratorBlock)aBlock;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Enumerate over the collection using the given
block. The first argument is the object and the
second is the index in the array. The final argument
is a pointer to a BOOL indicating whether the
enumeration should stop. Setting this to
<code>YES</code> will interrupt the enumeration. The
<var>opts</var> argument is a bitfield. Setting the
NSNSEnumerationConcurrent flag
specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-firstObject">firstObject </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>firstObject</b>;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the first object in the receiver, or
<code>nil</code> if the receiver is empty.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-firstObjectCommonWithArray$">firstObjectCommonWithArray: </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>firstObjectCommonWithArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)otherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the first object found in the receiver
(starting at index 0) which is present in the
<var>otherArray</var> as determined by using the
<a rel="gsdoc" href="#method$NSArray-containsObject$">
-containsObject:
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-getObjects$">getObjects: </a></h3>
- (void) <b>getObjects:</b> (__unsafe_unretained id[])aBuffer;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Copies the objects from the receiver to
<var>aBuffer</var>, which must be an area of memory
large enough to hold them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-getObjects$range$">getObjects: range: </a></h3>
- (void) <b>getObjects:</b> (__unsafe_unretained id[])aBuffer<b> range:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Copies the objects from the range <var>aRange</var>
of the receiver to <var>aBuffer</var>, which must be an
area of memory large enough to hold them.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObject$">indexOfObject: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the first object found in the
receiver which is equal to <var>anObject</var>
(using anObject's
[NSObject -isEqual:]
method). Returns NSNotFound on failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObject$inRange$">indexOfObject: inRange: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObject:</b> (id)anObject<b> inRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the first object found in
<var>aRange</var> of receiver which is equal to
<var>anObject</var> (using anObject's
[NSObject -isEqual:]
method). Returns NSNotFound on failure.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObject$inSortedRange$options$usingComparator$">indexOfObject: inSortedRange: options: usingComparator: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObject:</b> (id)key<b> inSortedRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)range<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSBinarySearchingOptions">NSBinarySearchingOptions</a>)options<b> usingComparator:</b> (NSComparator)comparator;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Performs a binary search of the array within the
specified <var>range</var> for the index of an
object equal to obj according to cmp. If
NSBinarySearchingInsertionIndex
is specified, searches for the index at which such an
object should be inserted.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObjectAtIndexes$options$passingTest$">indexOfObjectAtIndexes: options: passingTest: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObjectAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexSet<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> passingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the index of the first object in the
specified range in a collection that matches the
condition specified by the block. The
<var>opts</var> argument is a bitfield. Setting the
NSNSEnumerationConcurrent flag
specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObjectIdenticalTo$">indexOfObjectIdenticalTo: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObjectIdenticalTo:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the specified object in the
receiver, or NSNotFound if the object is not
present.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObjectIdenticalTo$inRange$">indexOfObjectIdenticalTo: inRange: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObjectIdenticalTo:</b> (id)anObject<b> inRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the index of the specified object in the
range of the receiver, or NSNotFound if the object is
not present.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObjectPassingTest$">indexOfObjectPassingTest: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObjectPassingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the index of the first object in the array
that matches the condition specified by the block.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexOfObjectWithOptions$passingTest$">indexOfObjectWithOptions: passingTest: </a></h3>
- (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>) <b>indexOfObjectWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> passingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the index of the first object in the array
that matches the condition specified by the block. The
<var>opts</var> argument is a bitfield. Setting the
NSNSEnumerationConcurrent flag
specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexesOfObjectsAtIndexes$options$passingTest$">indexesOfObjectsAtIndexes: options: passingTest: </a></h3>
- (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*) <b>indexesOfObjectsAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexSet<b> options:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> passingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the indexes of the objects in a collection
that match the condition specified by the block and
are in the range specified by the index set. The
<var>opts</var> argument is a bitfield. Setting the
NSNSEnumerationConcurrent flag
specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexesOfObjectsPassingTest$">indexesOfObjectsPassingTest: </a></h3>
- (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*) <b>indexesOfObjectsPassingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the indexes of the objects in a collection
that match the condition specified by the block.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-indexesOfObjectsWithOptions$passingTest$">indexesOfObjectsWithOptions: passingTest: </a></h3>
- (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*) <b>indexesOfObjectsWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSEnumerationOptions">NSEnumerationOptions</a>)opts<b> passingTest:</b> (GSPredicateBlock)predicate;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns the indexes of the objects in a collection
that match the condition specified by the block. The
<var>opts</var> argument is a bitfield. Setting the
NSNSEnumerationConcurrent flag
specifies that it is thread-safe. The
NSEnumerationReverse bit specifies
that it should be enumerated in reverse order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-init">init </a></h3>
- (instancetype) <b>init</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
In MacOS-X class clusters do not have designated
initialisers, and there is a general rule
that <a rel="gsdoc" href="#method$NSArray-init">-init</a>
is
treated as the designated initialiser of the
class cluster, but that other intitialisers may not
work s expected an would need to be individually
overridden in any subclass.
</p>
<p>
</p>
<p>
GNUstep tries to make it easier to subclass a
class cluster, by making class clusters follow the
same convention as normal classes, so the designated
initialiser is the <em>richest</em>
initialiser. This means that all other
initialisers call the documented designated
initialiser (which calls
<a rel="gsdoc" href="#method$NSArray-init">
-init
</a>
only for MacOS-X compatibility), and anyone writing
a subclass only needs to override that one initialiser
in order to have all the other ones work.
</p>
<p>
</p>
<p>
For MacOS-X compatibility, you may also need to
override various other initialisers. Exactly
which ones, you will need to determine by trial on
a MacOS-X system... and may vary between releases of
MacOS-X. So to be safe, on MacOS-X you probably
need to re-implement <em>all</em> the class cluster
initialisers you might use in conjunction
with your subclass.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithArray$">initWithArray: </a></h3>
- (instancetype) <b>initWithArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)array;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize the receiver with the contents of
<var>array</var>. The order of <var>array</var> is
preserved. <br /> Invokes
<a rel="gsdoc" href="#method$NSArray-initWithObjects$count$">
-initWithObjects:count:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithArray$copyItems$">initWithArray: copyItems: </a></h3>
- (instancetype) <b>initWithArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)array<b> copyItems:</b> (BOOL)shouldCopy;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Initialize the receiver with the contents of
<var>array</var>. The order of <var>array</var> is
preserved. <br /> If <var>shouldCopy</var> is
<code>YES</code> then the objects are copied rather
than simply retained. <br /> Invokes
<a rel="gsdoc" href="#method$NSArray-initWithObjects$count$">
-initWithObjects:count:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithContentsOfFile$">initWithContentsOfFile: </a></h3>
- (instancetype) <b>initWithContentsOfFile:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)file;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Initialises the array with the contents of
the specified <var>file</var>, which must contain an
array in property-list format.
</p>
<p>
</p>
<p>
In GNUstep, the property-list format may be either the
OpenStep format (ASCII data), or the MacOS-X
format (UTF-8 XML data)... this method will
recognise which it is.
</p>
<p>
</p>
<p>
If there is a failure to load the <var>file</var> for
any reason, the receiver will be released, the method
will return <code>nil</code>, and a warning may be
logged.
</p>
<p>
</p>
<p>
Works by invoking
<a rel="gsdoc" href="NSString.html#method$NSString-initWithContentsOfFile$">[NSString -initWithContentsOfFile:]</a>
and <a rel="gsdoc" href="NSString.html#method$NSString-propertyList">[NSString -propertyList]</a>
then checking that the result is an array.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithContentsOfURL$">initWithContentsOfURL: </a></h3>
- (instancetype) <b>initWithContentsOfURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)aURL;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
</p>
<p>
Initialises the array with the contents of
the specified URL, which must contain an array in
property-list format.
</p>
<p>
</p>
<p>
In GNUstep, the property-list format may be either the
OpenStep format (ASCII data), or the MacOS-X
format (UTF8 XML data)... this method will
recognise which it is.
</p>
<p>
</p>
<p>
If there is a failure to load the URL for any reason,
the receiver will be released, the method will return
<code>nil</code>, and a warning may be logged.
</p>
<p>
</p>
<p>
Works by invoking
<a rel="gsdoc" href="NSString.html#method$NSString-initWithContentsOfURL$">[NSString -initWithContentsOfURL:]</a>
and <a rel="gsdoc" href="NSString.html#method$NSString-propertyList">[NSString -propertyList]</a>
then checking that the result is an array.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithObjects$,...">initWithObjects: ,...</a></h3>
- (instancetype) <b>initWithObjects:</b> (id)firstObject<b>,...</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialize the array the list of objects. <br />
May change the value of self before returning it.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-initWithObjects$count$">initWithObjects: count: </a></h3>
- (instancetype) <b>initWithObjects:</b> (const id[])objects<b> count:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)count;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
This is a designated initialiser for the class.<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
This should initialize the array with <var>count</var>
(may be zero) <var>objects</var>. <br /> Retains each
object placed in the array. <br /> Calls
<a rel="gsdoc" href="#method$NSArray-init">
-init
</a>
(which does nothing but maintain MacOS-X
compatibility), and needs to be
re-implemented in subclasses in order to
have all other initialisers work.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-isEqualToArray$">isEqualToArray: </a></h3>
- (BOOL) <b>isEqualToArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)otherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns <code>YES</code> if the receiver is equal
to <var>otherArray</var>, <code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-lastObject">lastObject </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>lastObject</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the last object in the receiver, or
<code>nil</code> if the receiver is empty.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-makeObjectsPerform$">makeObjectsPerform: </a></h3>
- (void) <b>makeObjectsPerform:</b> (SEL)aSelector;<br />
<div class="availability">
<b>Availability:</b> OPENSTEP 4.0.0 removed at MacOS-X 10.0.0</div>
<br />
<div class="desc">
Obsolete version of
<a rel="gsdoc" href="#method$NSArray-makeObjectsPerformSelector$">
-makeObjectsPerformSelector:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-makeObjectsPerform$withObject$">makeObjectsPerform: withObject: </a></h3>
- (void) <b>makeObjectsPerform:</b> (SEL)aSelector<b> withObject:</b> (id)argument;<br />
<div class="availability">
<b>Availability:</b> OPENSTEP 4.0.0 removed at MacOS-X 10.0.0</div>
<br />
<div class="desc">
Obsolete version of
<a rel="gsdoc" href="#method$NSArray-makeObjectsPerformSelector$withObject$">-makeObjectsPerformSelector:withObject:</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-makeObjectsPerformSelector$">makeObjectsPerformSelector: </a></h3>
- (void) <b>makeObjectsPerformSelector:</b> (SEL)aSelector;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Makes each object in the array perform
<var>aSelector</var>. <br /> This is done
sequentially from the first to the last
object.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-makeObjectsPerformSelector$withObject$">makeObjectsPerformSelector: withObject: </a></h3>
- (void) <b>makeObjectsPerformSelector:</b> (SEL)aSelector<b> withObject:</b> (id)arg;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Makes each object in the array perform
<var>aSelector</var> with <var>arg</var>. <br /> This
is done sequentially from the first to the last object.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-objectAtIndex$">objectAtIndex: </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>objectAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Returns the object at the specified
<var>index</var>. Raises an exception of the
<var>index</var> is beyond the array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-objectAtIndexedSubscript$">objectAtIndexedSubscript: </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>objectAtIndexedSubscript:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)anIndex;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Accessor for subscripting. This is called by the
compiler when you write code like anArray[12]. It
should not be called directly.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-objectEnumerator">objectEnumerator </a></h3>
- (GS_GENERIC_CLASS(NSEnumerator,ElementT)*) <b>objectEnumerator</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an enumerator describing the array
sequentially from the first to the last
element. <br /> If you use a mutable subclass of
NSArray, you should not modify the array during
enumeration.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-objectsAtIndexes$">objectsAtIndexes: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>objectsAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexes;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-pathsMatchingExtensions$">pathsMatchingExtensions: </a></h3>
- (GS_GENERIC_CLASS(NSArray,NSString*)*) <b>pathsMatchingExtensions:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)extensions;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Assumes that the receiver is an array of paths, and
returns an array formed by selecting the subset of
those patch matching the specified array of
<var>extensions</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-reverseObjectEnumerator">reverseObjectEnumerator </a></h3>
- (GS_GENERIC_CLASS(NSEnumerator,ElementT)*) <b>reverseObjectEnumerator</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an enumerator describing the array
sequentially from the last to the first
element. <br /> If you use a mutable subclass of
NSArray, you should not modify the array during
enumeration.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-setValue$forKey$">setValue: forKey: </a></h3>
- (void) <b>setValue:</b> (id)value<b> forKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Call setValue:forKey: on each of the receiver's items
with the <var>value</var> and <var>key</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayHint">sortedArrayHint </a></h3>
- (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*) <b>sortedArrayHint</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Subclasses may provide a hint for sorting... The
default GNUstep implementation just returns
<code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayUsingComparator$">sortedArrayUsingComparator: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>sortedArrayUsingComparator:</b> (NSComparator)comparator;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns a sorted array using the
<var>comparator</var> to determine the order of
objects.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayUsingFunction$context$">sortedArrayUsingFunction: context: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>sortedArrayUsingFunction:</b> (NSComparisonResult(*)(id,id,void*))comparator<b> context:</b> (void*)context;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array in which the objects
are ordered according to a sort with
<var>comparator</var>. This invokes
<a rel="gsdoc" href="#method$NSArray-sortedArrayUsingFunction$context$hint$">-sortedArrayUsingFunction:context:hint:</a>
with a <code>nil</code> hint.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayUsingFunction$context$hint$">sortedArrayUsingFunction: context: hint: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>sortedArrayUsingFunction:</b> (NSComparisonResult(*)(id,id,void*))comparator<b> context:</b> (void*)context<b> hint:</b> (<a rel="gsdoc" href="NSData.html#class$NSData">NSData</a>*)hint;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array in which the objects
are ordered according to a sort with
<var>comparator</var>, where the
<var>comparator</var> function is passed two objects
to compare, and the <var>context</var> as the third
argument. The <var>hint</var> argument is
currently ignored, and may be <code>nil</code>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayUsingSelector$">sortedArrayUsingSelector: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>sortedArrayUsingSelector:</b> (SEL)comparator;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns an autoreleased array in which the objects
are ordered according to a sort with
<var>comparator</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-sortedArrayWithOptions$usingComparator$">sortedArrayWithOptions: usingComparator: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>sortedArrayWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSSortOptions">NSSortOptions</a>)options<b> usingComparator:</b> (NSComparator)comparator;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Returns a sorted array using the block to determine
the order of objects. The opts argument is a bitfield.
Setting the NSSortConcurrent flag specifies that it
is thread-safe. The NSSortStable bit specifies that it
should keep equal objects in the same order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-subarrayWithRange$">subarrayWithRange: </a></h3>
- (GS_GENERIC_CLASS(NSArray,ElementT)*) <b>subarrayWithRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns a subarray of the receiver containing the
objects found in the specified range
<var>aRange</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-valueForKey$">valueForKey: </a></h3>
- (GS_GENERIC_TYPE(ElementT)) <b>valueForKey:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)key;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
This overrides NSObjects implementation of this
method. This method returns an array of objects
returned by invoking
<a rel="gsdoc" href="#method$NSArray-valueForKey$">
-valueForKey:
</a>
for each item in the receiver, substituting NSNull for
<code>nil</code>. A special case: the <var>key</var>
"count" is not forwarded to each object of the
receiver but returns the number of objects of the
receiver. <br />
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-writeToFile$atomically$">writeToFile: atomically: </a></h3>
- (BOOL) <b>writeToFile:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)path<b> atomically:</b> (BOOL)useAuxiliaryFile;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
</p>
<p>
Writes the contents of the array to the file
specified by <var>path</var>. The file contents
will be in property-list format... under GNUstep
this is either OpenStep style (ASCII characters
using \U hexadecimal escape sequences for unicode),
or MacOS-X style (XML in the UTF8 character set).
</p>
<p>
</p>
<p>
If the <var>useAuxiliaryFile</var> flag is
<code>YES</code>, the file write operation is
atomic... the data is written to a temporary file,
which is then renamed to the actual file name.
</p>
<p>
</p>
<p>
If the conversion of data into the correct
property-list format fails or the write
operation fails, the method returns
<code>NO</code>, otherwise it returns
<code>YES</code>.
</p>
<p>
</p>
<p>
NB. The fact that the file is in property-list format
does not necessarily mean that it can be used to
reconstruct the array using the
<a rel="gsdoc" href="#method$NSArray-initWithContentsOfFile$">
-initWithContentsOfFile:
</a>
method. If the original array contains
non-property-list objects, the
descriptions of those objects will have been
written, and reading in the file as a
property-list will result in a new array
containing the string descriptions.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSArray-writeToURL$atomically$">writeToURL: atomically: </a></h3>
- (BOOL) <b>writeToURL:</b> (<a rel="gsdoc" href="NSURL.html#class$NSURL">NSURL</a>*)url<b> atomically:</b> (BOOL)useAuxiliaryFile;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
</p>
<p>
Writes the contents of the array to the specified
<var>url</var>. This functions just like
<a rel="gsdoc" href="#method$NSArray-writeToFile$atomically$">
-writeToFile:atomically:
</a>
except that the output may be written to any URL,
not just a local file.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="002000000000">
Software documentation for the NSMutableArray class
</a></h1>
<h2><a name="class$NSMutableArray">NSMutableArray</a> : <a rel="gsdoc" href="#class$NSArray">NSArray</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSArray.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<code>NSMutableArray</code> is the mutable version of
<a rel="gsdoc" href="#class$NSArray">NSArray</a>
. It provides methods for altering the contents of the
array.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray+arrayWithCapacity$">+arrayWithCapacity:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-addObject$">-addObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-addObjectsFromArray$">-addObjectsFromArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-exchangeObjectAtIndex$withObjectAtIndex$">-exchangeObjectAtIndex:withObjectAtIndex:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-initWithCapacity$">-initWithCapacity:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-insertObject$atIndex$">-insertObject:atIndex:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-insertObjects$atIndexes$">-insertObjects:atIndexes:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeAllObjects">-removeAllObjects</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeLastObject">-removeLastObject</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObject$">-removeObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObject$inRange$">-removeObject:inRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectAtIndex$">-removeObjectAtIndex:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectIdenticalTo$">-removeObjectIdenticalTo:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectIdenticalTo$inRange$">-removeObjectIdenticalTo:inRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectsAtIndexes$">-removeObjectsAtIndexes:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectsFromIndices$numIndices$">-removeObjectsFromIndices:numIndices:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectsInArray$">-removeObjectsInArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-removeObjectsInRange$">-removeObjectsInRange:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-replaceObjectAtIndex$withObject$">-replaceObjectAtIndex:withObject:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-replaceObjectsAtIndexes$withObjects$">-replaceObjectsAtIndexes:withObjects:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-replaceObjectsInRange$withObjectsFromArray$">-replaceObjectsInRange:withObjectsFromArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-replaceObjectsInRange$withObjectsFromArray$range$">-replaceObjectsInRange:withObjectsFromArray:range:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-setArray$">-setArray:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-setObject$atIndexedSubscript$">-setObject:atIndexedSubscript:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-sortUsingComparator$">-sortUsingComparator:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-sortUsingFunction$context$">-sortUsingFunction:context:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-sortUsingSelector$">-sortUsingSelector:</a></li>
<li><a rel="gsdoc" href="NSArray.html#method$NSMutableArray-sortWithOptions$usingComparator$">-sortWithOptions:usingComparator:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSMutableArray+arrayWithCapacity$">arrayWithCapacity: </a></h3>
+ (instancetype) <b>arrayWithCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)numItems;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Creates an autoreleased mutable array able to store
at least <var>numItems</var>. See the
<a rel="gsdoc" href="#method$NSMutableArray-initWithCapacity$">
-initWithCapacity:
</a>
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-addObject$">addObject: </a></h3>
- (void) <b>addObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Adds <var>anObject</var> at the end of the array, thus
increasing the size of the array. The object is
retained upon addition.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-addObjectsFromArray$">addObjectsFromArray: </a></h3>
- (void) <b>addObjectsFromArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)otherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Adds each object from <var>otherArray</var> to the
receiver, in first to last order.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-exchangeObjectAtIndex$withObjectAtIndex$">exchangeObjectAtIndex: withObjectAtIndex: </a></h3>
- (void) <b>exchangeObjectAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)i1<b> withObjectAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)i2;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.0.0</div>
<br />
<div class="desc">
Swaps the positions of two objects in the array.
Raises an exception if either array index is out of
bounds.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-initWithCapacity$">initWithCapacity: </a></h3>
- (instancetype) <b>initWithCapacity:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)numItems;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
This is a designated initialiser for the class.<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Initialise the array with the specified capacity
... this should ensure that the array can have
<var>numItems</var> added efficiently. <br /> Calls
<a rel="gsdoc" href="#method$NSArray-init">
-init
</a>
(which does nothing but maintain MacOS-X
compatibility), and needs to be
re-implemented in subclasses in order to
have all other initialisers work.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-insertObject$atIndex$">insertObject: atIndex: </a></h3>
- (void) <b>insertObject:</b> (id)anObject<b> atIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Inserts an object into the receiver at the
specified location. <br /> Raises an exception if
given an array <var>index</var> which is too large.
<br /> The size of the array increases by one.
<br /> The object is retained by the array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-insertObjects$atIndexes$">insertObjects: atIndexes: </a></h3>
- (void) <b>insertObjects:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)objects<b> atIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexes;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Inserts the values from the <var>objects</var>
array into the receiver at the locations given by the
<var>indexes</var> set. <br /> The values are
inserted in the same order that they appear in the
array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeAllObjects">removeAllObjects </a></h3>
- (void) <b>removeAllObjects</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all objects from the receiver, leaving an
empty array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeLastObject">removeLastObject </a></h3>
- (void) <b>removeLastObject</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes the last object in the array. Raises an
exception if the array is already empty.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObject$">removeObject: </a></h3>
- (void) <b>removeObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all occurrences of <var>anObject</var>
(found by anObject's
[NSObject -isEqual:]
method) from the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObject$inRange$">removeObject: inRange: </a></h3>
- (void) <b>removeObject:</b> (id)anObject<b> inRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all occurrences of <var>anObject</var>
(found by the
[NSObject -isEqual:]
method of <var>anObject</var>) <var>aRange</var> in
the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectAtIndex$">removeObjectAtIndex: </a></h3>
- (void) <b>removeObjectAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Removes an object from the receiver at the
specified location. <br /> The size of the array
decreases by one. <br /> Raises an exception if
given an array <var>index</var> which is too large.
<br />
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectIdenticalTo$">removeObjectIdenticalTo: </a></h3>
- (void) <b>removeObjectIdenticalTo:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all occurrences of <var>anObject</var>
(found by pointer equality) from the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectIdenticalTo$inRange$">removeObjectIdenticalTo: inRange: </a></h3>
- (void) <b>removeObjectIdenticalTo:</b> (id)anObject<b> inRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all occurrences of <var>anObject</var>
(found by pointer equality) from <var>aRange</var>
in the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectsAtIndexes$">removeObjectsAtIndexes: </a></h3>
- (void) <b>removeObjectsAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexes;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes objects from the receiver at the indices
supplied by an NSIndexSet
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectsFromIndices$numIndices$">removeObjectsFromIndices: numIndices: </a></h3>
- (void) <b>removeObjectsFromIndices:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>*)indices<b> numIndices:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)count;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Supplied with a C array of <var>indices</var>
containing <var>count</var> values, this method
removes all corresponding objects from the
receiver. The objects are removed in such a way
that the removal is <em>safe</em> irrespective of the
order in which they are specified in the
<var>indices</var> array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectsInArray$">removeObjectsInArray: </a></h3>
- (void) <b>removeObjectsInArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)otherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes from the receiver, all the objects present
in <var>otherArray</var>, as determined by using the
[NSObject -isEqual:]
method.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-removeObjectsInRange$">removeObjectsInRange: </a></h3>
- (void) <b>removeObjectsInRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Removes all the objects in <var>aRange</var> from
the receiver.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-replaceObjectAtIndex$withObject$">replaceObjectAtIndex: withObject: </a></h3>
- (void) <b>replaceObjectAtIndex:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)index<b> withObject:</b> (id)anObject;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
Subclasses <strong>must</strong> override this method.<br />
<div class="desc">
Places an object into the receiver at the specified
location. <br /> Raises an exception if given an
array <var>index</var> which is too large. <br /> The
object is retained by the array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-replaceObjectsAtIndexes$withObjects$">replaceObjectsAtIndexes: withObjects: </a></h3>
- (void) <b>replaceObjectsAtIndexes:</b> (<a rel="gsdoc" href="NSIndexSet.html#class$NSIndexSet">NSIndexSet</a>*)indexes<b> withObjects:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)objects;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.4.0</div>
<br />
<div class="desc">
Replaces the values in the receiver at the
locations given by the <var>indexes</var> set
with values from the <var>objects</var> array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-replaceObjectsInRange$withObjectsFromArray$">replaceObjectsInRange: withObjectsFromArray: </a></h3>
- (void) <b>replaceObjectsInRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange<b> withObjectsFromArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)anArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Replaces objects in the receiver with those from
<var>anArray</var>. <br /> Raises an exception if
given a range extending beyond the array. <br />
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-replaceObjectsInRange$withObjectsFromArray$range$">replaceObjectsInRange: withObjectsFromArray: range: </a></h3>
- (void) <b>replaceObjectsInRange:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)aRange<b> withObjectsFromArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)anArray<b> range:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSRange">NSRange</a>)anotherRange;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Replaces objects in the receiver with some of
those from <var>anArray</var>. <br /> Raises an
exception if given a range extending beyond the
array. <br />
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-setArray$">setArray: </a></h3>
- (void) <b>setArray:</b> (<a rel="gsdoc" href="#class$NSArray">NSArray</a>*)otherArray;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sets the contents of the receiver to be identical to
the contents of <var>otherArray</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-setObject$atIndexedSubscript$">setObject: atIndexedSubscript: </a></h3>
- (void) <b>setObject:</b> (id)anObject<b> atIndexedSubscript:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSUInteger">NSUInteger</a>)anIndex;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.8.0</div>
<br />
<div class="desc">
Set method called by the compiler with array
subscripting. <br /> Replaces the object at
<var>anIndex</var> or, if <var>anIndex</var> is the
length of the array, this method appends abObject to
the array.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-sortUsingComparator$">sortUsingComparator: </a></h3>
- (void) <b>sortUsingComparator:</b> (NSComparator)comparator;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Sorts the array using the specified
<var>comparator</var> block.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-sortUsingFunction$context$">sortUsingFunction: context: </a></h3>
- (void) <b>sortUsingFunction:</b> (NSComparisonResult(*)(id,id,void*))compare<b> context:</b> (void*)context;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sorts the array according to the supplied
<var>compare</var> function with the
<var>context</var> information.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-sortUsingSelector$">sortUsingSelector: </a></h3>
- (void) <b>sortUsingSelector:</b> (SEL)comparator;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Sorts the array according to the supplied
<var>comparator</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSMutableArray-sortWithOptions$usingComparator$">sortWithOptions: usingComparator: </a></h3>
- (void) <b>sortWithOptions:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSSortOptions">NSSortOptions</a>)options<b> usingComparator:</b> (NSComparator)comparator;<br />
<div class="availability">
<b>Availability:</b> MacOS-X 10.6.0</div>
<br />
<div class="desc">
Sorts the array using the specified
<var>comparator</var> block and <var>options</var>.
</div>
<hr width="25%" align="left" />
</div>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
Server : Apache/2.4.41 (Ubuntu)