diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-06-09 11:04:17 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-06-09 13:24:35 -0700 |
commit | bde1baeddb216b7ab6322646d9bdf3bb629c4c25 (patch) | |
tree | 2be97ca7229e2e10700ce503b28db142952a157e | |
parent | 6b98e89515ba0ee755bdc9c4783b84b464d2a10c (diff) |
Add XmuNCopyISOLatin1Lowered & XmuNCopyISOLatin1Uppered to doc/Xmu.xml
Also add notes to the originals warning about buffer overflow
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | doc/Xmu.xml | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/doc/Xmu.xml b/doc/Xmu.xml index 10d1c11..f0d6a05 100644 --- a/doc/Xmu.xml +++ b/doc/Xmu.xml @@ -2146,6 +2146,49 @@ assumed to be encoded using ISO 8859-1. </para> <para> +Note that like <function>strcpy</function> the caller is responsible for +ensuring the size of <parameter>dst</parameter> is at least as large as the +size of <parameter>src</parameter>. + </para> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>XmuNCopyISOLatin1Lowered</function></funcdef> + <paramdef>char *<parameter>dst</parameter></paramdef> + <paramdef>const char *<parameter>src</parameter></paramdef> + <paramdef>int <parameter>size</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>dst</parameter></term> + <listitem><para> +returns the string copy + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>src</parameter></term> + <listitem><para> +specifies the string to copy + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem><para> +maximum number of characters (including the null terminator) to write to dst + </para></listitem> + </varlistentry> + </variablelist> + +This function copies up to <code><parameter>size</parameter> - 1</code> +characters of a null terminated string from <parameter>src</parameter> +to <parameter>dst</parameter>, and terminates it with a null, +changing all Latin-1 uppercase letters to lowercase. The string is +assumed to be encoded using ISO 8859-1. + </para> + + <para> <funcsynopsis> <funcprototype> <funcdef>void <function>XmuCopyISOLatin1Uppered</function></funcdef> @@ -2174,6 +2217,49 @@ assumed to be encoded using ISO 8859-1. </para> <para> +Note that like <function>strcpy</function> the caller is responsible for +ensuring the size of <parameter>dst</parameter> is at least as large as the +size of <parameter>src</parameter>. + </para> + + <para> + <funcsynopsis> + <funcprototype> + <funcdef>void <function>XmuNCopyISOLatin1Uppered</function></funcdef> + <paramdef>char *<parameter>dst</parameter></paramdef> + <paramdef>const char *<parameter>src</parameter></paramdef> + <paramdef>int <parameter>size</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>dst</parameter></term> + <listitem><para> +returns the string copy + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>src</parameter></term> + <listitem><para> +specifies the string to copy + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem><para> +maximum number of characters (including the null terminator) to write to dst + </para></listitem> + </varlistentry> + </variablelist> + +This function copies up to <code><parameter>size</parameter> - 1</code> +characters of a null terminated string from <parameter>src</parameter> +to <parameter>dst</parameter>, and terminates it with a null, +changing all Latin-1 lowercase letters to uppercase. The string is +assumed to be encoded using ISO 8859-1. + </para> + + <para> <funcsynopsis> <funcprototype> <funcdef>int <function>XmuCompareISOLatin1</function></funcdef> |