<!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>Get the length of a field</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ingres-fetch-row.html">ingres_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ingres-field-name.html">ingres_field_name</a></div>
<div class="up"><a href="ref.ingres.html">Ingres Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ingres-field-length" class="refentry">
<div class="refnamediv">
<h1 class="refname">ingres_field_length</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5 < 5.1.0, PECL ingres >= 1.0.0)</p><p class="refpurpose"><span class="refname">ingres_field_length</span> — <span class="dc-title">Get the length of a field</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ingres-field-length-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ingres_field_length</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">$index</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>ingres_field_length()</strong></span> returns the length of a
field. This is the number of bytes the server uses to store
the field. For detailed information, see the Ingres <em>OpenAPI User
Guide</em>, Appendix <em>"Data Types"</em> in the Ingres documentation.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>Related Configurations</strong><br />
<p class="para">
See <a href="ingres.configuration.html#ini.ingres.array-index-start" class="link">ingres.array_index_start</a>
in <a href="ingres.configuration.html" class="link">Runtime Configuration</a>
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.ingres-field-length-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">result</code></dt>
<dd>
<p class="para">
The query result identifier
</p>
</dd>
<dt>
<code class="parameter">index</code></dt>
<dd>
<p class="para">
<code class="parameter">index</code> is the column number whose length
will be retrieved.
</p>
<p class="para">
The possible values of <code class="parameter">index</code> depend upon
the value
of <a href="ingres.configuration.html#ini.ingres.array-index-start" class="link">ingres.array_index_start</a>.
If <a href="ingres.configuration.html#ini.ingres.array-index-start" class="link">ingres.array_index_start</a>
is <em>1</em> (the default)
then <code class="parameter">index</code> must be
between <em>1</em> and the value returned
by <span class="function"><a href="function.ingres-num-fields.html" class="function">ingres_num_fields()</a></span>. If <a href="ingres.configuration.html#ini.ingres.array-index-start" class="link">ingres.array_index_start</a>
is <em>0</em> then <code class="parameter">index</code> must
be between <em>0</em>
and <span class="function"><a href="function.ingres-num-fields.html" class="function">ingres_num_fields()</a></span><em> -
1</em>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ingres-field-length-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the length of a field.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ingres-field-length-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.ingres-query.html" class="function" rel="rdfs-seeAlso">ingres_query()</a> - Send an SQL query to Ingres</span></li>
<li class="member"><span class="function"><a href="function.ingres-fetch-array.html" class="function" rel="rdfs-seeAlso">ingres_fetch_array()</a> - Fetch a row of result into an array</span></li>
<li class="member"><span class="function"><a href="function.ingres-fetch-assoc.html" class="function" rel="rdfs-seeAlso">ingres_fetch_assoc()</a> - Fetch a row of result into an associative array</span></li>
<li class="member"><span class="function"><a href="function.ingres-fetch-object.html" class="function" rel="rdfs-seeAlso">ingres_fetch_object()</a> - Fetch a row of result into an object</span></li>
<li class="member"><span class="function"><a href="function.ingres-fetch-row.html" class="function" rel="rdfs-seeAlso">ingres_fetch_row()</a> - Fetch a row of result into an enumerated array</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ingres-fetch-row.html">ingres_fetch_row</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ingres-field-name.html">ingres_field_name</a></div>
<div class="up"><a href="ref.ingres.html">Ingres Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
