File: filepro.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (155 lines) | stat: -rw-r--r-- 4,882 bytes parent folder | download
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
<?xml version="1.0" encoding="utf-8"?>
 <reference id="ref.filepro">
  <title>filePro functions</title>
  <titleabbrev>filePro</titleabbrev>

  <partintro>
   <simpara>
    These functions allow read-only access to data stored in filePro databases.</simpara>
   <simpara>
    filePro is a registered trademark of fP Technologies, Inc. You can find more
    information about filePro at <ulink url="&url.filepro;">&url.filepro;</ulink>.</simpara>  
  </partintro>

  <refentry id="function.filepro">
   <refnamediv>
    <refname>filepro</refname>
    <refpurpose>read and verify the map file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>filepro</methodname>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para>
     This reads and verifies the map file, storing the field count
     and info.</para>
    <para>
     No locking is done, so you should avoid modifying your filePro
     database while it may be opened in PHP.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldname">
   <refnamediv>
    <refname>filepro_fieldname</refname>
    <refpurpose>gets the name of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_fieldname</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the name of the field corresponding to <parameter>field_number</parameter>.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldtype">
   <refnamediv>
    <refname>filepro_fieldtype</refname>
    <refpurpose>gets the type of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_fieldtype</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the edit type of the field corresponding to <parameter>field_number</parameter>.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldwidth">
   <refnamediv>
    <refname>filepro_fieldwidth</refname>
    <refpurpose>gets the width of a field</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_fieldwidth</methodname>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the width of the field corresponding to <parameter>field_number</parameter>.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-retrieve">
   <refnamediv>
    <refname>filepro_retrieve</refname>
    <refpurpose>retrieves data from a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>filepro_retrieve</methodname>
      <methodparam><type>int</type><parameter>row_number</parameter></methodparam>
      <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Returns the data from the specified location in the database.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-fieldcount">
   <refnamediv>
    <refname>filepro_fieldcount</refname>
    <refpurpose>find out how many fields are in a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_fieldcount</methodname>
      <void/>
     </methodsynopsis>
    <para>
	Returns the number of fields (columns) in the opened filePro
	database.</para>
    <para>
     See also <function>filepro</function>.</para>
   </refsect1>
  </refentry>

  <refentry id="function.filepro-rowcount">
   <refnamediv>
    <refname>filepro_rowcount</refname>
    <refpurpose>find out how many rows are in a filePro database</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>int</type><methodname>filepro_rowcount</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Returns the number of rows in the opened filePro database.</para>
    <para>
     See also <function>filepro</function>.</para>
   </refsect1>
  </refentry>

 </reference>

<!-- 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:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->