mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
e0a77554a4
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323979 c90b9560-bf6c-de11-be94-00142212c4b1
200 lines
6 KiB
XML
200 lines
6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Get column information from a result and return as an object</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>
|
|
This function returns an object with certain properties of the specific
|
|
column. The properties of the object are:
|
|
</para>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem><para>column name</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>table</parameter></term>
|
|
<listitem><para>name of the table that the column belongs to</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>def</parameter></term>
|
|
<listitem><para>default value of the column</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>max_length</parameter></term>
|
|
<listitem><para>maximum length of the column</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>not_null</parameter></term>
|
|
<listitem><para>1 if the column cannot be NULL</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>primary_key</parameter></term>
|
|
<listitem><para>1 if the column is a primary key</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>unique_key</parameter></term>
|
|
<listitem><para>1 if the column is an unique key</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>multiple_key</parameter></term>
|
|
<listitem><para>1 if the column is a non-unique key</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>numeric</parameter></term>
|
|
<listitem><para>1 if the column is numeric</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>blob</parameter></term>
|
|
<listitem><para>1 if the column is a BLOB</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>type</parameter></term>
|
|
<listitem><para>the type of the column</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>unsigned</parameter></term>
|
|
<listitem><para>1 if the column is unsigned</para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>zerofill</parameter></term>
|
|
<listitem><para>1 if the column is zero-filled</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>result</parameter></term>
|
|
<listitem><para><parameter>result</parameter> comes from a call to <function>cubrid_execute</function></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>field_offset</parameter></term>
|
|
<listitem><para>
|
|
The numerical field offset. If the field offset is not specified, the
|
|
next field (that was not yet retrieved by this function) is retrieved.
|
|
The <parameter>field_offset</parameter> starts at 0.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Object with certain properties of the specific column, when process is successful.
|
|
</para>
|
|
<para>
|
|
&false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>cubrid_fetch_field</function> example</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
|
|
-->
|