Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
- iOS 7.0+
- macOS 10.9+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
- Xcode 9.3+
A valid index of the array.
The distance to offset
A valid index of the collection to use as a limit. If
distance > 0,
limitshould be greater than
ito have any effect. Likewise, if
distance < 0,
limitshould be less than
ito have any effect.
An index offset by
distance from the index
i, unless that index would be beyond
limit in the direction of movement. In that case, the method returns
The following example obtains an index advanced four positions from an array’s starting index and then prints the element at that position. The operation doesn’t require going beyond the limiting
numbers value, so it succeeds.
The next example attempts to retrieve an index ten positions from
numbers, but fails, because that distance is beyond the index passed as
The value passed as
distance must not offset
i beyond the bounds of the collection, unless the index passed as
limit prevents offsetting beyond those bounds.