Source of: /manual/en/function.mssql-field-length.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mssql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mssql-field-length.php',
1 => 'mssql_field_length',
),
'up' =>
array (
0 => 'ref.mssql.php',
1 => 'Mssql Functions',
),
'prev' =>
array (
0 => 'function.mssql-fetch-row.php',
1 => 'mssql_fetch_row',
),
'next' =>
array (
0 => 'function.mssql-field-name.php',
1 => 'mssql_field_name',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mssql-field-length" class="refentry">
<div class="refnamediv">
<h1 class="refname">mssql_field_length</h1>
<p class="verinfo">(PHP 4, PHP 5, PECL odbtp >= 1.1.1)</p><p class="refpurpose"><span class="refname">mssql_field_length</span> — <span class="dc-title">Get the length of a field</span></p>
</div>
<a name="function.mssql-field-length.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>mssql_field_length</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$result</tt></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$offset</tt><span class="initializer"> = -1</span></span>
] )</div>
<p class="para rdfs-comment">
Returns the length of field no. <i><tt class="parameter">offset</tt></i>
in
<i><tt class="parameter">result</tt></i>
.
</p>
</div>
<a name="function.mssql-field-length.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">result</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The result resource that is being evaluated. This result comes from a
call to <a href="function.mssql-query.php" class="function">mssql_query()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">offset</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The field offset, starts at 0. If omitted, the current field is used.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mssql-field-length.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The length of the specified field index on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.mssql-field-length.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mssql_field_length()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Connect MSSQL<br /></span><span style="color: #0000BB">mssql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'MANGO\SQLEXPRESS'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'phpfi'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mssql_select_db</span><span style="color: #007700">(</span><span style="color: #DD0000">'php'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Send a select query to MSSQL<br /></span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #0000BB">mssql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT [name], [age] FROM [php].[dbo].[persons]'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Print the field type and length<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'The field \'age\' has a data length of ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mssql_field_length</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Free the query result<br /></span><span style="color: #0000BB">mssql_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
The field 'age' has a data length of 4
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.mssql-field-length.notes"></a><div class="refsect1 notes">
<h3 class="title">Notes</h3>
<blockquote><p><b class="note">Note</b>:
<b>Note to Windows Users</b><br />
Due to a limitation in the underlying API used by PHP (MS DBLib C API),
the length of <i>VARCHAR</i> fields is limited to
<em class="emphasis">255</em>. If you need to store more data, use a
<i>TEXT</i> field instead.
<br />
</p></blockquote>
</div>
<a name="function.mssql-field-length.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mssql-field-name.php" class="function" rel="rdfs-seeAlso">mssql_field_name()</a> - Get the name of a field</li>
<li class="member"><a href="function.mssql-field-type.php" class="function" rel="rdfs-seeAlso">mssql_field_type()</a> - Gets the type of a field</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
