Instance Method

enumerate(options:using:)

Executes a given Block over the index set’s indexes, using the specified enumeration options.

Declaration

func enumerate(options opts: NSEnumerationOptions = [], using block: (Int, UnsafeMutablePointer<ObjCBool>) -> Void)

Parameters

opts

A bitmask that specifies the options for the enumeration (whether it should be performed concurrently and whether it should be performed in reverse order). See NSEnumerationOptions for the supported values.

block

The Block to apply to elements in the set.

The Block takes two arguments:

idx

The index of the object.

stop

A reference to a Boolean value. The block can set the value to true to stop further processing of the set. The stop argument is an out-only argument. You should only ever set this Boolean to YES within the Block.

Discussion

This method executes synchronously.

See Also

Enumerating Indexes

func enumerate((Int, UnsafeMutablePointer<ObjCBool>) -> Void)

Executes a given Block using each object in the index set.

func enumerate(in: NSRange, options: NSEnumerationOptions, using: (Int, UnsafeMutablePointer<ObjCBool>) -> Void)

Executes a given Block using the indexes in the specified range, using the specified enumeration options.

func makeIterator() -> NSIndexSetIterator

Returns an iterator over the elements of this sequence.

struct NSIndexSetIterator

An iterator suitable for enumerating the elements of an index set.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software