1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!-- Process this file with docbook-to-man to generate an nroff manual
4     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6     less'.  A typical entry in a Makefile or Makefile.am is:
7
8manpage.1: manpage.sgml
9	docbook-to-man $< > $@
10
11
12	The docbook-to-man binary is found in the docbook-to-man package.
13	Please remember that if you create the nroff version in one of the
14	debian/rules file targets (such as build), you will need to include
15	docbook-to-man in your Build-Depends control field.
16
17  -->
18
19  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20  <!ENTITY dhfirstname "<firstname>UWE</firstname>">
21  <!ENTITY dhsurname   "<surname>STEINMANN</surname>">
22  <!-- Please adjust the date whenever revising the manpage. -->
23  <!ENTITY dhdate      "<date>August 22, 2005</date>">
24  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25       allowed: see man(7), man(1). -->
26  <!ENTITY dhsection   "<manvolnum>3</manvolnum>">
27  <!ENTITY dhemail     "<email>uwe@steinmann.cx</email>">
28  <!ENTITY dhusername  "Uwe Steinmann">
29  <!ENTITY dhucpackage "<refentrytitle>PX_TIME2STRING</refentrytitle>">
30  <!ENTITY funcname    "PX_time2string">
31
32  <!ENTITY debian      "<productname>Debian</productname>">
33  <!ENTITY gnu         "<acronym>GNU</acronym>">
34  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
35]>
36
37<refentry>
38  <refentryinfo>
39    <address>
40      &dhemail;
41    </address>
42    <author>
43      &dhfirstname;
44      &dhsurname;
45    </author>
46    <copyright>
47      <year>2005</year>
48      <holder>&dhusername;</holder>
49    </copyright>
50    &dhdate;
51  </refentryinfo>
52  <refmeta>
53    &dhucpackage;
54
55    &dhsection;
56  </refmeta>
57  <refnamediv>
58    <refname>&funcname;</refname>
59
60    <refpurpose>Convert paradox time into formatted string</refpurpose>
61  </refnamediv>
62  <refsynopsisdiv>
63    <para>#include &lt;paradox.h&gt;</para>
64		<para>char * &funcname;(pxdoc_t *pxdoc, long time, const char *format)</para>
65  </refsynopsisdiv>
66  <refsect1>
67    <title>DESCRIPTION</title>
68
69    <para>Creates a string representation of a paradox time as specified
70			in the parameter <parameter>format</parameter>.  The time must be
71			either retrieved with <function>PX_get_data_long(3)</function> after
72			calling <function>PX_get_record(3)</function> or by simply using the
73			long value in the pxval_t struct as returned by
74			<function>PX_retrieve_record(3)</function>. The function uses internally
75			the <function>PX_timestamp2string(3)</function> function.
76			The format string may contain all chars as documented with
77			<function>PX_timestamp2string(3)</function>, though only those concerning
78			the time will produce resonable results.</para>
79
80  </refsect1>
81  <refsect1>
82    <title>RETURN VALUE</title>
83    <para>Returns pointer to string on success and NULL on failure.</para>
84  </refsect1>
85  <refsect1>
86    <title>SEE ALSO</title>
87
88    <para>PX_timestamp2string(3), PX_date2string(3)</para>
89
90  </refsect1>
91  <refsect1>
92    <title>AUTHOR</title>
93
94    <para>This manual page was written by &dhusername; &dhemail;.</para>
95
96  </refsect1>
97</refentry>
98
99<!-- Keep this comment at the end of the file
100Local variables:
101mode: sgml
102sgml-omittag:t
103sgml-shorttag:t
104sgml-minimize-attributes:nil
105sgml-always-quote-attributes:t
106sgml-indent-step:2
107sgml-indent-data:t
108sgml-parent-document:nil
109sgml-default-dtd-file:nil
110sgml-exposed-tags:nil
111sgml-local-catalogs:nil
112sgml-local-ecat-files:nil
113End:
114-->
115
116
117