From f3d8514681a6a9a0664d3ad0b6b72eb87346f92f Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 14 Jan 2021 23:24:53 +0000
Subject:  Prepare for 2.3.5.0, s6dns_message_get_domain_nodecode() now public

---
 doc/libs6dns/s6dns-message.html | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

(limited to 'doc/libs6dns/s6dns-message.html')

diff --git a/doc/libs6dns/s6dns-message.html b/doc/libs6dns/s6dns-message.html
index 315b375..14c5527 100644
--- a/doc/libs6dns/s6dns-message.html
+++ b/doc/libs6dns/s6dns-message.html
@@ -134,9 +134,14 @@ the series of character-strings.
 </p>
 
 <p>
-<code> unsigned int s6dns_message_get_domain (s6dns_domain_t *d, char const *packet, unsigned int packetlen, unsigned int *pos) </code> <br />
-Reads a domain and stores it, in string form, into *<em>d</em>.
-Returns 1 on success and 0 on failure, and sets errno:
+<code> size_t s6dns_message_get_domain_nodecode (char *out, size_t outmax, char const *packet, unsigned int packetlen, unsigned int *pos) </code> <br />
+Reads a domain and stores it, in packet form, into *<em>out</em>, which is a character
+array that must have been preallocated by the user; <em>outmax</em> is the maximum
+number of characters that can be stored in <em>out</em>. As a special
+case, <em>out</em> can be NULL, in which case nothing will be written, but
+the domain will still be parsed and <em>pos</em> will still be updated.
+The function returns the number of characters written to <em>out</em>
+(or that would have been). If 0, it denotes a failure, and errno is set:
 </p>
 
 <ul>
@@ -145,8 +150,16 @@ Returns 1 on success and 0 on failure, and sets errno:
 misused. </li>
  <li> EPROTONOSUPPORT: the domain encoding uses an extension that the function
 does not recognize. </li>
+ <li> ENAMETOOLONG: the domain cannot be stored in <em>outmax</em> characters. </li>
 </ul>
 
+<p>
+<code> unsigned int s6dns_message_get_domain (s6dns_domain_t *d, char const *packet, unsigned int packetlen, unsigned int *pos) </code> <br />
+Reads a domain and stores it, in string form, into *<em>d</em>.
+Returns 1 on success and 0 on failure, and sets errno just like the
+function above.
+</p>
+
 <p>
 <code> int s6dns_message_get_hinfo (s6dns_message_rr_hinfo_t *p, char const *packet, unsigned int packetlen, unsigned int *pos) </code> <br />
 Reads a HINFO RR and stores it into *<em>p</em>. Returns 1 on success or 0
-- 
cgit v1.2.3