mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
6aaa26b850
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308991 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.6 KiB
XML
119 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.cubrid-field-flags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>cubrid_field_flags</refname>
|
|
<refpurpose>Return a string with the flags of the given field offset</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>cubrid_field_flags</methodname>
|
|
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>field_offset</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns a string with the flags of the given field offset
|
|
separated by space. You can split the returned value using explode. The
|
|
possible flags could be: <constant>not_null</constant>,
|
|
<constant>primary_key</constant>, <constant>unique_key</constant>,
|
|
<constant>foreign_key</constant>, <constant>auto_increment</constant>,
|
|
<constant>shared</constant>, <constant>reverse_index</constant>,
|
|
<constant>reverse_unique</constant> and <constant>timestamp</constant>.
|
|
</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. The <parameter>field_offset</parameter>
|
|
starts at 0. If <parameter>field_offset</parameter> does not exist, an
|
|
error of level <constant>E_WARNING</constant> is also issued.
|
|
</para></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A string with flags, when process is successful.
|
|
</para>
|
|
<para>
|
|
&false; when invalid field_offset value.
|
|
</para>
|
|
<para>
|
|
-1 if SQL sentence is not SELECT.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>cubrid_field_flags</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$conn = cubrid_connect("localhost", 33000, "demodb");
|
|
$result = cubrid_execute($conn, "SELECT * FROM game WHERE host_year=2004 AND nation_code='AUS' AND medal='G'");
|
|
|
|
$col_num = cubrid_num_cols($result);
|
|
|
|
printf("%-30s %s\n", "Field Name", "Field Flags");
|
|
for($i = 0; $i < $col_num; $i++) {
|
|
printf("%-30s %s\n", cubrid_field_name($result, $i), cubrid_field_flags($result, $i));
|
|
}
|
|
|
|
cubrid_disconnect($conn);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Field Name Field Flags
|
|
host_year not_null primary_key unique_key
|
|
event_code not_null primary_key unique_key foreign_key
|
|
athlete_code not_null primary_key unique_key foreign_key
|
|
stadium_code not_null
|
|
nation_code
|
|
medal
|
|
game_date
|
|
]]>
|
|
</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
|
|
-->
|