lsearch(3)                                                   lsearch(3)

  lsearch()

  NAME

    lsearch(), lfind() - linear searching routines

  SYNOPSIS

    char * lsearch (const void *key, const void *base, size_t *nelp,
                    size_t width, int (*compar)(void *, void *))
    char * lfind (const void *key, const void *base, size_t *nelp,
                  size_t width, int (*compar)(void *, void *))

  DESCRIPTION

    The functions lsearch(3) and lfind(3) provide basic linear searching
    functionality.

    Base is the pointer to the beginning of an array. The argument nelp is the
    current number of elements in the array, where each element is width bytes
    long. The compar function is a comparison routine which is used to compare
    two elements. It takes two arguments which point to the key object and to
    an array member, in that order, and must return an integer less than,
    equivalent to, or greater than zero if the key object is considered,
    respectively, to be less than, equal to, or greater than the array member.

    The lsearch(3) and lfind(3) functions return a pointer into the array
    referenced by base where key is located. If key does not exist, lfind(3)
    will return a null pointer and lsearch(3) will add it to the array. When
    an element is added to the array by lsearch(3) the location referenced by
    the argument nelp is incremented by one.

  SEE ALSO

    bsearch(3)

  USAGE NOTES

    All of these functions are thread safe.

    None of these functions are async-signal safe.