[sr-dev] git:master:56cdf70e: registrar: documented lookup_to_dset() cfg function [skip ci]

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 56cdf70ea008b5401bdd7d1824f15788f85fc6fa
URL: https://github.com/kamailio/kamailio/commit/56cdf70ea008b5401bdd7d1824f15788f85fc6fa

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-03-12T09:04:09+01:00

registrar: documented lookup_to_dset() cfg function [skip ci]

- function available for long time, but somehow was not documented
- GH #2623

---

Modified: src/modules/registrar/doc/registrar_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/56cdf70ea008b5401bdd7d1824f15788f85fc6fa.diff
Patch: https://github.com/kamailio/kamailio/commit/56cdf70ea008b5401bdd7d1824f15788f85fc6fa.patch

---

diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml
index f4bb213b14..e310636f01 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -1338,7 +1338,8 @@ save("location", "0x00", "sip:test at kamailio.org");
 		<programlisting format="linespecific">
 ...
 lookup("location");
-switch ($retcode) {
+			switch ($retcode) {:1
+
     case -1:
     case -3:
         sl_send_reply("404", "Not Found");
@@ -1352,6 +1353,29 @@ switch ($retcode) {
 		</example>
 	</section>
 
+	<section id="registrar.f.lookup_to_dset">
+		<title>
+		<function moreinfo="none">lookup_to_dset(domain [, uri])</function>
+		</title>
+		<para>
+			Similar to lookup(...), but push the location contacts to destination
+			set, without changing the R-URI (first branch not changed, it creates
+			additional branches). For the meaning of the parameters and the return
+			codes, see the documentation for lookup(...) function.
+		</para>
+		<para>
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
+		</para>
+		<example>
+		<title><function>lookup_to_dset</function> usage</title>
+		<programlisting format="linespecific">
+...
+lookup_to_dset("location");
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="registrar.f.lookup_branches">
 		<title>
 		<function moreinfo="none">lookup_branches(domain)</function>