/
cubrid-fetch-field.xml
199 lines (185 loc) · 6.31 KB
/
cubrid-fetch-field.xml
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: chuso Status: ready -->
<refentry xml:id="function.cubrid-fetch-field" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cubrid_fetch_field</refname>
<refpurpose>Devuelve un objeto con ciertas propiedades</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>cubrid_fetch_field</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Esta función devuelve un objeto con ciertas propiedades de la columna
especificada. Las propiedades del objeto son:
</para>
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para>nombre de la columna</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>table</parameter></term>
<listitem><para>nombre de la tabla a la que pertenece la columna</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>def</parameter></term>
<listitem><para>valor predeterminado de la columna</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_length</parameter></term>
<listitem><para>longitud máxima de la columna</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>not_null</parameter></term>
<listitem><para>1 si la columna no puede ser NULL</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>primary_key</parameter></term>
<listitem><para>1 si la columna es una clave primaria</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>unique_key</parameter></term>
<listitem><para>1 si la columna es clave única</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>multiple_key</parameter></term>
<listitem><para>1 si la columna no es clave única</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>numeri</parameter></term>
<listitem><para>1 si la columna es numérica</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob</parameter></term>
<listitem><para>1 si la columna es un BLOB</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para>el tipo de la columna</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>unsigned</parameter></term>
<listitem><para>1 si la columna no tiene signo</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>zerofill</parameter></term>
<listitem><para>1 si la columna se rellena con ceros</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem><para><parameter>result</parameter> proviene de una llamada a la función <function>cubrid_execute</function></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem><para>El índice del campo numérico. Si el índice del campo no se especifica, se
recupera el siguiente campo (el que aún no ha sido recuperado por esta función).
<parameter>field_offset</parameter> comienza en 0.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Un objeto con ciertas propiedades de la columna especificada, cuando el proceso tuvo éxito.
</para>
<para>
&false; en caso de error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Ejemplo de <function>cubrid_fetch_field</function></title>
<programlisting role="php">
<![CDATA[
<?php
$conn = cubrid_connect("localhost", 33000, "demodb");
$req = cubrid_execute($conn, "SELECT event_code,athlete_code,nation_code,game_date FROM game WHERE host_year=1988 and event_code=20001;");
var_dump(cubrid_fetch_row($req));
cubrid_field_seek($req, 1);
$field = cubrid_fetch_field($req);
printf("\n--- Field Properties ---\n");
printf("%-30s %s\n", "name:", $field->name);
printf("%-30s %s\n", "table:", $field->table);
printf("%-30s \"%s\"\n", "default value:", $field->def);
printf("%-30s %d\n", "max length:", $field->max_length);
printf("%-30s %d\n", "not null:", $field->not_null);
printf("%-30s %d\n", "primary key:", $field->primary_key);
printf("%-30s %d\n", "unique key:", $field->unique_key);
printf("%-30s %d\n", "multiple key:", $field->multiple_key);
printf("%-30s %d\n", "numeric:", $field->numeric);
printf("%-30s %d\n", "blob:", $field->blob);
printf("%-30s %s\n", "type:", $field->type);
printf("%-30s %d\n", "unsigned:", $field->unsigned);
printf("%-30s %d\n", "zerofill:", $field->zerofill);
cubrid_close_request($req);
cubrid_disconnect($conn);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(4) {
[0]=>
string(5) "20001"
[1]=>
string(5) "16681"
[2]=>
string(3) "KOR"
[3]=>
string(9) "1988-9-30"
}
--- Field Properties ---
name: athlete_code
table: game
default value: ""
max length: 0
not null: 1
primary key: 1
unique key: 1
multiple key: 0
numeric: 1
blob: 0
type: integer
unsigned: 0
zerofill: 0
]]>
</screen>
</example>
</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:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->