瀏覽代碼

textops: docs for via_param_rm(...)

Daniel-Constantin Mierla 2 年之前
父節點
當前提交
fb2be3855c
共有 1 個文件被更改,包括 35 次插入0 次删除
  1. 35 0
      src/modules/textops/doc/textops_admin.xml

+ 35 - 0
src/modules/textops/doc/textops_admin.xml

@@ -2303,5 +2303,40 @@ msg_apply_changes();
 		</example>
 	</section>
 
+	<section id="textops.f.via_param_rm">
+		<title>
+		<function moreinfo="none">via_param_rm(name, idx)</function>
+		</title>
+		<para>
+		Remove parameter matching by name from Via body at the specified index.
+		The index starts from 0 (first Via body). Negative index counts from the
+		end of the list for Via header bodies (-1 is the last Via body).
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>name</emphasis> - name of the parameter
+			</para>
+		</listitem>
+		<listitem>
+			<para><emphasis>idx</emphasis> - index of the Via body.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>The parameters can also be variables.</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+
+		<example>
+		<title><function>via_param_rm</function> usage</title>
+		<programlisting format="linespecific">
+...
+via_param_rm("p1", "0");
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 </chapter>