diff --git a/reference/strings/functions/substr-compare.xml b/reference/strings/functions/substr-compare.xml index defde59728..0ca3510318 100644 --- a/reference/strings/functions/substr-compare.xml +++ b/reference/strings/functions/substr-compare.xml @@ -1,5 +1,5 @@ - + substr_compare @@ -18,7 +18,40 @@ boolcase_sensitivity - &warn.undocumented.func; + + substr_compare compares main_str + from position offset with str + up to length characters. + + + Returns < 0 if main_str from position + offset is less than str, > + 0 if it is greater than str, and 0 if they are equal. + If length is equal or greater than length of + main_str and length is set, + substr_compare prints warning and returns &false;. + + + If case_sensitivity is &true;, comparison is case + sensitive. + + + + A <function>substr_compare</function> example + + +]]> + + +