DESCRIPTION

A macro equivalent exists for each function call.
Because the macro forms are sometimes faster and have a simpler error
handling interface than the equivalent functions,
they are the preferred way of calling the JudyL functions.
See JudyL(3)
for more information.
The function call definitions are included here for completeness.

One of the difficulties in using the JudyL function calls lies in
determining whether to pass a pointer or the address of a pointer.
Since the functions that modify the JudyL array must also modify the
pointer to the JudyL array, you must pass the address of the pointer
rather than the pointer itself.
This often leads to hard-to-debug programmatic errors.
In practice, the macros allow the compiler to catch programming
errors when pointers instead of addresses of pointers are passed.

The JudyL function calls have an additional parameter beyond
those specified in the macro calls. This parameter is either a
pointer to an error structure, or NULL (in which case the
detailed error information is not returned).

In the following descriptions, the functions are described in
terms of how the macros use them (only in the case of
#define JUDYERROR_NOTEST 1). This is the suggested use
of the macros after your program has been fully debugged.
When the JUDYERROR_NOTEST macro is not specified,
an error structure is declared to store error information
returned from the JudyL functions when an error occurs.

Definitions for all the Judy functions, the types
Pvoid_t,
Pcvoid_t,
PPvoid_t,
Word_t,
JError_t,
and
PJError_t,
the constants
NULL,
JU_ERRNO_*,
JERR,
PPJERR,
and
PJE0,
are provided in the Judy.h header file
(/usr/include/Judy.h).
Note: Callers should define JudyL arrays as type Pvoid_t,
which can be passed by value to functions that take
Pcvoid_t (constant Pvoid_t),
and also by address to functions that take PPvoid_t.

The return type from most JudyL functions is PPvoid_t so
that the values stored in the array can be pointers to other objects,
which is a typical usage, or cast to a Word_t * when a pointer
to a Value is required instead of a pointer to a pointer.