<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Return a string with the flags of the given field offset</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cubrid-fetch-row.html">cubrid_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-field-len.html">cubrid_field_len</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.cubrid-field-flags" class="refentry">
<div class="refnamediv">
<h1 class="refname">cubrid_field_flags</h1>
<p class="verinfo">(PECL CUBRID >= 8.3.0)</p><p class="refpurpose"><span class="refname">cubrid_field_flags</span> — <span class="dc-title">Return a string with the flags of the given field offset</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.cubrid-field-flags-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>cubrid_field_flags</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$field_offset</code></span>
)</div>
<p class="para rdfs-comment">
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: <strong><code>not_null</code></strong>,
<strong><code>primary_key</code></strong>, <strong><code>unique_key</code></strong>,
<strong><code>foreign_key</code></strong>, <strong><code>auto_increment</code></strong>,
<strong><code>shared</code></strong>, <strong><code>reverse_index</code></strong>,
<strong><code>reverse_unique</code></strong> and <strong><code>timestamp</code></strong>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.cubrid-field-flags-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para"><em><code class="parameter">result</code></em> comes from a call to <span class="function"><a href="function.cubrid-execute.html" class="function">cubrid_execute()</a></span></p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">field_offset</code></em></span>
<dd>
<p class="para">
The numerical field offset. The <em><code class="parameter">field_offset</code></em>
starts at 0. If <em><code class="parameter">field_offset</code></em> does not exist, an
error of level <strong><code>E_WARNING</code></strong> is also issued.
</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.cubrid-field-flags-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A string with flags, when process is successful.
</p>
<p class="para">
<strong><code>FALSE</code></strong> when invalid field_offset value.
</p>
<p class="para">
-1 if SQL sentence is not SELECT.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.cubrid-field-flags-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1076">
<p><strong>Example #1 <span class="function"><strong>cubrid_field_flags()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">33000</span><span style="color: #007700">, </span><span style="color: #DD0000">"demodb"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT * FROM game WHERE host_year=2004 AND nation_code='AUS' AND medal='G'"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$col_num </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_num_cols</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %s\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Field Name"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Field Flags"</span><span style="color: #007700">);<br />for(</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$col_num</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">cubrid_field_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">), </span><span style="color: #0000BB">cubrid_field_flags</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">)); <br />}<br /><br /></span><span style="color: #0000BB">cubrid_disconnect</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cubrid-fetch-row.html">cubrid_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-field-len.html">cubrid_field_len</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
