Merge pull request #6130 from JamesDeFabia/10332DocumentToFromHexPairs

HPCC-10332 Document ToHexPairs & FromHexPairs

Reviewed-by: Gavin Halliday <ghalliday@hpccsystems.com>

docs/ECLStandardLibraryReference/SLR-Mods/FromHexPairs.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<sect1 id="FromHexPairs">
+  <title>FromHexPairs</title>
+
+  <para><emphasis role="bold">STD.Str.FromHexPairs<indexterm>
+      <primary>STD.Str.FromHexPairs</primary>
+    </indexterm><indexterm>
+      <primary>Str.FromHexPairs</primary>
+    </indexterm><indexterm>
+      <primary>FromHexPairs</primary>
+    </indexterm>(</emphasis> <emphasis>source</emphasis> <emphasis
+  role="bold">)</emphasis> <emphasis role="bold"></emphasis></para>
+
+  <informaltable colsep="1" frame="all" rowsep="1">
+    <tgroup cols="2">
+      <colspec colwidth="80.50pt" />
+
+      <colspec />
+
+      <tbody>
+        <row>
+          <entry><emphasis>source</emphasis></entry>
+
+          <entry>The string containing the hex pairs to process.</entry>
+        </row>
+
+        <row>
+          <entry>Return:<emphasis> </emphasis></entry>
+
+          <entry>FromHexPairs returns a data value with each byte created from
+          a pair of hex digits.</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>The <emphasis role="bold">FromHexPairs </emphasis>function returns a
+  data value with each byte created from a pair of hex digits.</para>
+
+  <para>Example:</para>
+
+  <programlisting format="linespecific">A := STD.Str.FromHexPairs('0001FF80');</programlisting>
+</sect1>

docs/ECLStandardLibraryReference/SLR-Mods/ToHexPairs.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<sect1 id="ToHexPairs">
+  <title>ToHexPairs</title>
+
+  <para><emphasis role="bold">STD.Str.ToHexPairs<indexterm>
+      <primary>STD.Str.ToHexPairs</primary>
+    </indexterm><indexterm>
+      <primary>Str.ToHexPairs</primary>
+    </indexterm><indexterm>
+      <primary>ToHexPairs</primary>
+    </indexterm>(</emphasis> <emphasis>source</emphasis> <emphasis
+  role="bold">)</emphasis> <emphasis role="bold"></emphasis></para>
+
+  <informaltable colsep="1" frame="all" rowsep="1">
+    <tgroup cols="2">
+      <colspec colwidth="80.50pt" />
+
+      <colspec />
+
+      <tbody>
+        <row>
+          <entry><emphasis>source</emphasis></entry>
+
+          <entry>The data value that should be expanded as a sequence of hex
+          pairs.</entry>
+        </row>
+
+        <row>
+          <entry>Return:<emphasis> </emphasis></entry>
+
+          <entry>ToHexPairs returns a string containing a sequence of hex
+          pairs.</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>The <emphasis role="bold">ToHexPairs </emphasis>function Converts the
+  data value to a sequence of hex pairs.</para>
+
+  <para>Example:</para>
+
+  <programlisting format="linespecific">A := STD.Str.ToHexPairs(D'\000\001\377\200');</programlisting>
+</sect1>

docs/ECLStandardLibraryReference/SLR-includer.xml

@@ -297,7 +297,10 @@
 
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/FindReplace.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+                
+    <xi:include href="ECLStandardLibraryReference/SLR-Mods/FromHexPairs.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />     
+                
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/GetNthWord.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
 
@@ -321,6 +324,9 @@
 
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/StartsWith.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
+                                
+    <xi:include href="ECLStandardLibraryReference/SLR-Mods/ToHexPairs.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />  
 
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/ToLowerCase.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />