CFArrayGetFirstIndexOfValue

Header: CFArray.h Carbon status: Supported

Searches the array for the value.

CFIndex CFArrayGetFirstIndexOfValue (
    CFArrayRef theArray, 
    CFRange range, 
    const void *value
);
Parameter descriptions
theArray

The array to be searched. If this parameter is not a valid CFArray, the behavior is undefined.

range

The range within the array to search. If the range location or end point (defined by the location plus length minus 1) are outside the index space of the array (0 to N-1 inclusive, where N is the count of the array), the behavior is undefined. If the range length is negative, the behavior is undefined. The range may be empty (length 0). The search progresses from the smallest index defined by the range to the largest.

value

The value for which to find a match in the array. The equal() callback provided when the array was created is used to compare. If the equal() callback was NULL, pointer equality (in C, ==) is used. If value, or any of the values in the array, are not understood by the equal() callback, the behavior is undefined.

function result

The lowest index of the matching values in the range, or -1 if no value in the range matched.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)