cp_multimap

Section: libcprops - cp_multimap (3)
Updated: OCT 2007
Index Return to Main Contents

NAME

cp_multimap_create_index - add an index on a multimap

SYNOPSIS

cp_index *cp_multimap_create_index(cp_multimap *map,
                                    cp_index_type type,
                                    cp_key_fn key,
                                    cp_compare_fn cmp,
                                    int *err);

DESCRIPTION

cp_multimap_create_index creates an index on an existing multimap.

type may be one of CP_UNIQUE or CP_MULTIPLE.

RETURN VALUE

cp_multimap_create_index returns the newly created index or NULL on error. If the err parameter is not NULL, the integer it points to is set to CP_MEMORY_ALLOCATION_FAILURE on allocation failure, or CP_EXISTS if an index with the same key and comparison functions already exists.

This document was created by man2html, using the manual pages.
Time: 18:30:35 GMT, December 01, 2007