File: PX_create_fp.sgml

package info (click to toggle)
pxlib 0.6.9-1
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,684 kB
  • sloc: ansic: 5,373; sh: 4,873; makefile: 127
file content (126 lines) | stat: -rw-r--r-- 4,184 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>UWE</firstname>">
  <!ENTITY dhsurname   "<surname>STEINMANN</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>August 29, 2005</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>3</manvolnum>">
  <!ENTITY dhemail     "<email>uwe@steinmann.cx</email>">
  <!ENTITY dhusername  "Uwe Steinmann">
  <!ENTITY dhucpackage "<refentrytitle>PX_CREATE_FP</refentrytitle>">
  <!ENTITY funcname    "PX_create_fp">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&funcname;</refname>

    <refpurpose>create a new Paradox file</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <para>#include &lt;paradox.h&gt;</para>
		<para>int &funcname;(pxdoc_t *pxdoc, pxfield_t *fields, int numfields, FILE *fp, int type)</para>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>Creates a new Paradox document in an already open file with the given
		  field specification. <option>pxdoc</option> must be created before
			with <function>PX_new(3)</function> or <function>PX_new2(3)</function>.
			The file must be opened in read/write mode
			(w+) with <function>fopen(3)</function>. <option>fields</option> is an
			array of <option>numfields</option> field specifications to set the
			schema of the database. The memory for the field specifications and
			field names must be allocated by the caller and may not be freed, since
			the memory is freed when the document is deleted. Make sure to use the
			same memory allocation function as passed to
			<function>PX_new(3)</function>. The memory for the field names is
			usually allocated with <function>PX_strdup(3)</function>.
			The field name can be
			left empty if a primary index file is to be created. The type of the
			file can be set in the last parameter. Currently only database
			(pxfFileTypIndexDB, pxfFileTypNonIndexDB) and
			primary index (pxfFileTypPrimIndex) files are supported.</para>
		<para>After creating the paradox database you may want to call
		  <function>PX_set_tablename(3)</function> in order to set the table
			name as it is stored in the header of the database.</para>

  </refsect1>
  <refsect1>
    <title>RETURN VALUE</title>
    <para>Returns 0 on success and -1 on failure.</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>PX_new2(3), PX_new(3), PX_create_file(3), PX_set_tablename(3)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->