chiark / gitweb /
adns_str* etc.: Permit calling on adns_s_* values (not _max_)
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 25 May 2020 12:01:17 +0000 (13:01 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 11 Jun 2020 15:13:02 +0000 (16:13 +0100)
This is useful because otherwise an application may not use these
values for its own errors, if that might result in them being passed
to the adns_strerror etc.

No code change: the table already has all the values.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
src/adns.h

index b8072ee..ba44b06 100644 (file)
@@ -1089,7 +1089,9 @@ const char *adns_errtypeabbrev(adns_status st);
  *
  * If you call these functions with status values not actually
  * returned from other functions in the same adns library, the
- * returned information may be NULL.
+ * returned information may be NULL.  (You are also guaranteed
+ * that the return value will not be NULL for values in the
+ * adns_status enum, *except* for adns_s_max_XXXX.)
  */
 
 #ifdef __cplusplus