maxmind / libmaxminddb

C library for the MaxMind DB file format
https://maxmind.github.io/libmaxminddb/
Apache License 2.0
918 stars 238 forks source link

Improvement needed in libmaxminddb docs #145

Open einhverfr opened 7 years ago

einhverfr commented 7 years ago

I notice that MMDB_get_entry_data_list has a *start parameter but this is not covered in the docs.

Is this the node value in the search tree? Or is it the file offset? Either way this should be clarified

oschwald commented 7 years ago

The *start parameter is an MMDB_entry_s value. In most cases, this will come from the MMDB_lookup_result_s value returned by MMDB_lookup_string() or MMDB_lookup_sockaddr(). This could be spelled out more, but the second example here does show how to get it and use it.