Bladeren bron

kamailio-kemi-framework: docs for htable.sht_get*() functions

Daniel-Constantin Mierla 5 jaren geleden
bovenliggende
commit
6c297158a0

+ 13 - 0
kamailio-kemi-framework/docs/modules.md

@@ -978,14 +978,27 @@ is not integer.
 
 <a target='_blank' href='/docs/modules/devel/modules/htable.html#htable.f.sht_get'> `xval sht_get(str "htname", str "itname")` </a>
 
+Return the integer or string value of the item.
+
+If the item does not exists, it returns `NULL`. Note that `NULL` might be represented differently in various scripting languages, such as `nil` or `None`.
+
 #### KSR.htable.sht_gete() ####
 
 <a target='_blank' href='/docs/modules/devel/modules/htable.html#htable.f.sht_gete'> `xval sht_gete(str "htname", str "itname")` </a>
 
+Return the integer or string value of the item.
+
+If the item does not exists, it returns an empty string.
+
 #### KSR.htable.sht_getw() ####
 
 <a target='_blank' href='/docs/modules/devel/modules/htable.html#htable.f.sht_getw'> `xval sht_getw(str "htname", str "itname")` </a>
 
+Return the integer or string value of the item.
+
+If the item does not exists, it returns the string `<null>`, suitable for use
+when writing log messages.
+
 #### KSR.htable.sht_inc() ####
 
 <a target='_blank' href='/docs/modules/devel/modules/htable.html#htable.f.sht_inc'> `int sht_inc(str "htname", str "itname")` </a>

+ 3 - 0
kamailio-kemi-framework/docs/modules/htable/htable.sht_get.md

@@ -0,0 +1,3 @@
+Return the integer or string value of the item.
+
+If the item does not exists, it returns `NULL`. Note that `NULL` might be represented differently in various scripting languages, such as `nil` or `None`.

+ 3 - 0
kamailio-kemi-framework/docs/modules/htable/htable.sht_gete.md

@@ -0,0 +1,3 @@
+Return the integer or string value of the item.
+
+If the item does not exists, it returns an empty string.

+ 4 - 0
kamailio-kemi-framework/docs/modules/htable/htable.sht_getw.md

@@ -0,0 +1,4 @@
+Return the integer or string value of the item.
+
+If the item does not exists, it returns the string `<null>`, suitable for use
+when writing log messages.