diff options
| author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-06-09 10:23:08 -0700 |
|---|---|---|
| committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-06-09 10:23:08 -0700 |
| commit | 13409196c36151e4b5212ae08e6cfda6d7c93696 (patch) | |
| tree | 367d81f4b3ab1a176362155879308ff9a280315c | |
| parent | a4a87ddfa4948c3f5c210ab7a472b65569ae0e64 (diff) | |
Add XmuSnprintf to doc/Xmu.xml
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
| -rw-r--r-- | doc/Xmu.xml | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/Xmu.xml b/doc/Xmu.xml index 34abad7..97135d8 100644 --- a/doc/Xmu.xml +++ b/doc/Xmu.xml @@ -450,6 +450,38 @@ such as whether to call <function>gethostname</function> or <function>uname</function>. </para> + <para> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>XmuSnprintf</function></funcdef> + <paramdef>char *<parameter>str</parameter></paramdef> + <paramdef>int <parameter>size</parameter></paramdef> + <paramdef><parameter>...</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <variablelist> + <varlistentry> + <term><parameter>str</parameter></term> + <listitem><para> +string to write output to + </para></listitem> + </varlistentry> + <varlistentry> + <term><parameter>size</parameter></term> + <listitem><para> +specifies the size of <parameter>str</parameter> + </para></listitem> + </varlistentry> + </variablelist> + +This function was provided as a portable implementation of +<function>snprintf</function> before all platforms could be +relied on to provide their own. It is now deprecated in favor of +calling <function>snprintf</function> directly and should only be used +in software that needs to continue to support non-Unix98 compliant platforms. + </para> + + </sect1> <sect1 id='window_utility_functions'> |