+ All PChar routines documented, and backslashes removed

docs/sysutils.xml

@@ -2606,7 +2606,7 @@ of the different elements is shown below:
 <dl>
 <dt>'%'</dt>
 <dd> starts the placeholder. If you want to insert a literal
-<var>\%</var> character, then you must insert two of them : <var>\%\%</var>.
+<var>%</var> character, then you must insert two of them : <var>%%</var>.
 </dd>
 <dt>Index ':'</dt>
 <dd> takes the <var>Index</var>-th element in the argument array
@@ -6115,76 +6115,129 @@ This constant is initialized by the initialization routines of the
 <element name="strlen">
 <short>Length of a null-terminated string.</short>
 <descr>
+Returns the length of the null-terminated string <var>P</var>.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrNew"/>
 </seealso>
+<example file="stringex/ex1"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strcopy">
 <short>Copy a null-terminated string</short>
 <descr>
+Copy the null terminated string in <var>Source</var> to <var>Dest</var>, and
+returns a pointer to <var>Dest</var>. <var>Dest</var> needs enough room to contain
+<var>Source</var>, i.e. <var>StrLen(Source)+1</var> bytes.
 </descr>
 <errors>
+No length checking is performed.
 </errors>
 <seealso>
+<link id="StrPCopy"/>
+<link id="StrLCopy"/>
+<link id="StrECopy"/>
 </seealso>
+<example file="stringex/ex4"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strlcopy">
 <short>Copy a null-terminated string, limited in length.</short>
 <descr>
+Copies <var>MaxLen</var> characters from <var>Source</var> to <var>Dest</var>, and makes
+<var>Dest</var> a null terminated string. 
 </descr>
 <errors>
+No length checking is performed.
 </errors>
 <seealso>
+<link id="StrCopy"/>
+<link id="StrECopy"/>
 </seealso>
+<example file="stringex/ex5"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strecopy">
 <short>Copy a null-terminated string, return a pointer to the end.</short>
 <descr>
+Copies the Null-terminated string in <var>Source</var> to <var>Dest</var>, and
+returns a pointer to the end (i.e. the terminating Null-character) of the
+copied string.
 </descr>
 <errors>
+No length checking is performed.
 </errors>
 <seealso>
+<link id="StrLCopy"/>
+<link id="StrCopy"/>
 </seealso>
+<example file="stringex/ex6"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strend">
 <short>Return a pointer to the end of a null-terminated string</short>
 <descr>
+Returns a pointer to the end of <var>P</var>. (i.e. to the terminating
+null-character.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLen"/>
 </seealso>
+<example file="stringex/ex7"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strcat">
 <short>Concatenate 2 null-terminated strings.</short>
 <descr>
+Attaches <var>Source</var> to <var>Dest</var> and returns <var>Dest</var>.
 </descr>
 <errors>
+No length checking is performed.
 </errors>
 <seealso>
+<link id="StrLCat"/>
 </seealso>
+<example file="stringex/ex11"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strcomp">
 <short>Compare 2 null-terminated strings, case sensitive.</short>
 <descr>
+<p>
+Compares the null-terminated strings <var>S1</var> and <var>S2</var>.
+The result is 
+</p>
+<ul>
+<li> A negative <var>Longint</var> when <var>S1&lt;S2</var>.
+</li>
+<li> 0 when <var>S1=S2</var>.
+</li>
+<li> A positive <var>Longint</var> when <var>S1&gt;S2</var>.
+</li>
+</ul>
+<p>
+For an example, see <link id="StrLComp"/>.
+</p>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLComp"/>
+<link id="StrIComp"/>
+<link id="StrLIComp"/>
 </seealso>
 </element>
 
@@ -6192,65 +6245,130 @@ This constant is initialized by the initialization routines of the
 <element name="strlcomp">
 <short>Compare limited number of characters of 2 null-terminated strings </short>
 <descr>
+<p>
+Compares maximum <var>L</var> characters of the null-terminated strings 
+<var>S1</var> and <var>S2</var>. 
+The result is 
+</p>
+<ul>
+<li> A negative <var>Longint</var> when <var>S1&lt;S2</var>.
+</li>
+<li> 0 when <var>S1=S2</var>.
+</li>
+<li> A positive <var>Longint</var> when <var>S1&gt;S2</var>.
+</li>
+</ul>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrComp"/>
+<link id="StrIComp"/>
+<link id="StrLIComp"/>
 </seealso>
+<example file="stringex/ex8"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="stricomp">
 <short>Compare 2 null-terminated strings, case insensitive.</short>
 <descr>
+<p>
+Compares the null-terminated strings <var>S1</var> and <var>S2</var>, ignoring case.
+The result is 
+</p>
+<ul>
+<li> A negative <var>Longint</var> when <var>S1&lt;S2</var>.
+</li>
+<li> 0 when <var>S1=S2</var>.
+</li>
+<li> A positive <var>Longint</var> when <var>S1&gt;S2</var>.
+</li>
+</ul>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLComp"/>
+<link id="StrComp"/>
+<link id="StrLIComp"/>
 </seealso>
+<example file="stringex/ex8"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strmove">
 <short>Move a null-terminated string to new location.</short>
 <descr>
+Copies <var>MaxLen</var> characters from <var>Source</var> to <var>Dest</var>. No
+terminating null-character is copied.
+Returns <var>Dest</var>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLCopy"/>
+<link id="StrCopy"/>
 </seealso>
+<example file="stringex/ex10"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strlcat">
 <short>Concatenate 2 null-terminated strings, with length boundary.</short>
 <descr>
+Adds <var>MaxLen</var> characters from <var>Source</var> to <var>Dest</var>, and adds a
+terminating null-character. Returns <var>Dest</var>.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrCat"/>
 </seealso>
+<example file="stringex/ex12"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strscan">
 <short>Find first occurrence of a character in a null-terminated string.</short>
 <descr>
+Returns a pointer to the first occurrence of the character <var>C</var> in the
+null-terminated string <var>P</var>. If <var>C</var> does not occur, returns
+<var>Nil</var>.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrRScan"/>
+<link id="StrPos"/>
 </seealso>
+<example file="stringex/ex13"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strrscan">
 <short>Find last occurrence of a character in a null-terminated string.</short>
 <descr>
+<p>
+Returns a pointer to the last occurrence of the character <var>C</var> in the
+null-terminated string <var>P</var>. If <var>C</var> does not occur, returns
+<var>Nil</var>.
+</p>
+<p>
+For an example, see <link id="StrScan"/>.
+</p>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrScan"/>
+<link id="StrPos"/>
 </seealso>
 </element>
 
@@ -6258,21 +6376,33 @@ This constant is initialized by the initialization routines of the
 <element name="strlower">
 <short>Convert null-terminated string to all-lowercase.</short>
 <descr>
+Converts <var>P</var> to an all-lowercase string. Returns <var>P</var>.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrUpper"/>
 </seealso>
+<example file="stringex/ex14"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strupper">
 <short>Convert null-terminated string to all-uppercase</short>
 <descr>
+<p>
+Converts <var>P</var> to an all-uppercase string. Returns <var>P</var>.
+</p>
+<p>
+For an example, see <link id="StrLower"/>
+</p>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLower"/>
 </seealso>
 </element>
 
@@ -6281,10 +6411,30 @@ This constant is initialized by the initialization routines of the
 <short>Compare limited number of characters in 2 null-terminated strings,
 ignoring case.</short>
 <descr>
+<p>
+Compares maximum <var>L</var> characters of the null-terminated strings <var>S1</var> 
+and <var>S2</var>, ignoring case.
+The result is 
+</p>
+<ul>
+<li> A negative <var>Longint</var> when <var>S1&lt;S2</var>.
+</li>
+<li> 0 when <var>S1=S2</var>.
+</li>
+<li> A positive <var>Longint</var> when <var>S1&gt;S2</var>.
+</li>
+</ul>
+<p>
+For an example, see <link id="StrIComp"/>
+</p>
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrLComp"/>
+<link id="StrComp"/>
+<link id="StrIComp"/>
 </seealso>
 </element>
 
@@ -6292,22 +6442,33 @@ ignoring case.</short>
 <element name="strpos">
 <short>Find position of one null-terminated substring in another.</short>
 <descr>
+Returns a pointer to the first occurrence of <var>S2</var> in <var>S1</var>.
+If <var>S2</var> does not occur in <var>S1</var>, returns <var>Nil</var>.
 </descr>
 <errors>
+None.
 </errors>
 <seealso>
+<link id="StrScan"/>
+<link id="StrRScan"/>
 </seealso>
+<example file="stringex/ex15"/>
 </element>
 
 <!-- function Visibility: default -->
 <element name="strnew">
 <short>Allocate room for new null-terminated string.</short>
 <descr>
+Copies <var>P</var> to the Heap, and returns a pointer to the copy.
 </descr>
 <errors>
+Returns <var>Nil</var> if no memory was available for the copy.
 </errors>
 <seealso>
+<link id="StrCopy"/>
+<link id="StrDispose"/>
 </seealso>
+<example file="stringex/ex16"/>
 </element>
 
 <!-- function Visibility: default -->