Skip to content

Commit 93f6c58

Browse files
oschwaldclaude
andcommitted
Clarify MMDB_get_entry_data_list start parameter
Add an explicit description of the start parameter: it is an MMDB_entry_s value, typically obtained from the entry field of an MMDB_lookup_result_s returned by MMDB_lookup_string() or MMDB_lookup_sockaddr(). This mirrors the existing description for the data lookup functions. Relates to GitHub #145. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a4876b8 commit 93f6c58

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

doc/libmaxminddb.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ typedef struct MMDB_entry_data_list_s {
9292
9393
# DESCRIPTION
9494
95-
The libmaxminddb library provides functions for working with MaxMind DB files. See
96-
https://maxmind.github.io/MaxMind-DB/ for the MaxMind DB format
95+
The libmaxminddb library provides functions for working with MaxMind DB files.
96+
See https://maxmind.github.io/MaxMind-DB/ for the MaxMind DB format
9797
specification. The database and results are all represented by different
9898
data structures. Databases are opened by calling `MMDB_open()`. You can
9999
look up IP addresses as a string with `MMDB_lookup_string()` or as a
@@ -552,9 +552,9 @@ int MMDB_aget_value(
552552
The three functions allow three slightly different calling styles, but they
553553
all do the same thing.
554554
555-
The first parameter is an `MMDB_entry_s` value. In most cases this will come
556-
from the `MMDB_lookup_result_s` value returned by `MMDB_lookup_string()` or
557-
`MMDB_lookup_sockaddr()`.
555+
The first parameter is a pointer to an `MMDB_entry_s` struct. In most cases
556+
this will be a pointer to the `entry` field of the `MMDB_lookup_result_s`
557+
value returned by `MMDB_lookup_string()` or `MMDB_lookup_sockaddr()`.
558558
559559
The second parameter is a reference to an `MMDB_entry_data_s` structure. This
560560
will be populated with the data that is being looked up, if any is found. If
@@ -623,6 +623,10 @@ int MMDB_get_entry_data_list(
623623
MMDB_entry_data_list_s **const entry_data_list);
624624
```
625625

626+
The `start` parameter is a pointer to an `MMDB_entry_s` struct. In most cases
627+
this will be a pointer to the `entry` field of the `MMDB_lookup_result_s`
628+
value returned by `MMDB_lookup_string()` or `MMDB_lookup_sockaddr()`.
629+
626630
This function allows you to get all of the data for a complex data structure
627631
at once, rather than looking up each piece using repeated calls to
628632
`MMDB_get_value()`.

0 commit comments

Comments
 (0)