<strings>
<string id="pg_version" value="<div id='function.pg-version' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-version.php'>pg_version</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>pg_version</span> &amp;mdash; <span class='dc-title'> Returns an array with client, protocol and server version (when available) </span></p> </div> <a name='function.pg-version.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_version</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_version()</b> returns an array with the client, protocol and server version. Protocol and server versions are only available if PHP was compiled with PostgreSQL 7.4 or later. </p> <p class='para'> For more detailed server information, use <a href='http://www.php.net/manual/en/function.pg-parameter-status.php' class='function'>pg_parameter_status()</a>. </p> </div> <a name='function.pg-version.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-version.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array with <i>client</i>, <i>protocol</i> and <i>server_version</i> keys and values (if available). Returns <b><tt class='constant'>FALSE</tt></b> on error or invalid connection. </p> </div> <a name='function.pg-version.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_version()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=mary'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$v&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_version</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$v</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'client'</span><span style='color: #007700'>];<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 7.4 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-version.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-parameter-status.php' class='function' rel='rdfs-seeAlso'>pg_parameter_status()</a> - Looks up a current parameter setting of the server.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_update" value="<div id='function.pg-update' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-update.php'>pg_update</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_update</span> &amp;mdash; <span class='dc-title'> Update table </span></p> </div> <a name='function.pg-update.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_update</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$data</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$condition</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = PGSQL_DML_EXEC</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_update()</b> updates records that matches <i>condition</i> with <i>data</i>. If <i>options</i> is specified, <a href='http://www.php.net/manual/en/function.pg-convert.php' class='function'>pg_convert()</a> is applied to <i>data</i> with specified options. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-update.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table into which to update rows. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> whose keys are field names in the table <i><tt class='parameter'>table_name</tt></i> , and whose values are what matched rows are to be updated to. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>condition</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> whose keys are field names in the table <i><tt class='parameter'>table_name</tt></i> , and whose values are the conditions that a row must meet to be updated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Any number of <b><tt class='constant'>PGSQL_CONV_OPTS</tt></b>, <b><tt class='constant'>PGSQL_DML_NO_CONV</tt></b>, <b><tt class='constant'>PGSQL_DML_EXEC</tt></b> or <b><tt class='constant'>PGSQL_DML_STRING</tt></b> combined. If <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is part of the <i><tt class='parameter'>options</tt></i> then query string is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-update.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. Returns <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is passed via <i><tt class='parameter'>options</tt></i> . </p> </div> <a name='function.pg-update.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_update()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'field1'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'AA'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'field2'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'BB'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;safe,&amp;nbsp;since&amp;nbsp;$_POST&amp;nbsp;is&amp;nbsp;converted&amp;nbsp;automatically<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_update</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'post_log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Data&amp;nbsp;is&amp;nbsp;updated:&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;must&amp;nbsp;have&amp;nbsp;sent&amp;nbsp;wrong&amp;nbsp;inputs\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-update.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-convert.php' class='function' rel='rdfs-seeAlso'>pg_convert()</a> - Convert associative array values into suitable for SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_untrace" value="<div id='function.pg-untrace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-untrace.php'>pg_untrace</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_untrace</span> &amp;mdash; <span class='dc-title'>Disable tracing of a PostgreSQL connection</span></p> </div> <a name='function.pg-untrace.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_untrace</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> Stop tracing started by <a href='http://www.php.net/manual/en/function.pg-trace.php' class='function'>pg_trace()</a>. </p> </div> <a name='function.pg-untrace.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-untrace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Always returns <b><tt class='constant'>TRUE</tt></b>. </p> </div> <a name='function.pg-untrace.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_untrace()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_trace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'/tmp/trace.log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_untrace</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Now&amp;nbsp;tracing&amp;nbsp;of&amp;nbsp;backend&amp;nbsp;communication&amp;nbsp;is&amp;nbsp;disabled<br /></span><span style='color: #007700'>}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-untrace.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-trace.php' class='function' rel='rdfs-seeAlso'>pg_trace()</a> - Enable tracing a PostgreSQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_unescape_bytea" value="<div id='function.pg-unescape-bytea' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-unescape-bytea.php'>pg_unescape_bytea</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_unescape_bytea</span> &amp;mdash; <span class='dc-title'> Unescape binary for bytea type </span></p> </div> <a name='function.pg-unescape-bytea.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_unescape_bytea</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_unescape_bytea()</b> unescapes PostgreSQL bytea data values. It returns the unescaped string, possibly containing binary data. </p> <blockquote><p><b class='note'>Note</b>: When you <i>SELECT</i> a bytea type, PostgreSQL returns octal byte values prefixed with &amp;#039;\&amp;#039; (e.g. \032). Users are supposed to convert back to binary format manually. <br /> This function requires PostgreSQL 7.2 or later. With PostgreSQL 7.2.0 and 7.2.1, bytea values must be cast when you enable multi-byte support. i.e. <i>INSERT INTO test_table (image) VALUES (&amp;#039;$image_escaped&amp;#039;::bytea);</i> PostgreSQL 7.2.2 or later does not need a cast. The exception is when the client and backend character encoding does not match, and there may be multi-byte stream error. User must then cast to bytea to avoid this error. <br /> </p></blockquote> </div> <a name='function.pg-unescape-bytea.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'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing PostgreSQL bytea data to be converted into a PHP binary string. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-unescape-bytea.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the unescaped data. </p> </div> <a name='function.pg-unescape-bytea.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_unescape_bytea()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;the&amp;nbsp;bytea&amp;nbsp;data<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;data&amp;nbsp;FROM&amp;nbsp;gallery&amp;nbsp;WHERE&amp;nbsp;name='Pine&amp;nbsp;trees''</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$raw&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'data'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Convert&amp;nbsp;to&amp;nbsp;binary&amp;nbsp;and&amp;nbsp;send&amp;nbsp;to&amp;nbsp;the&amp;nbsp;browser<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_unescape_bytea</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$raw</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-unescape-bytea.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-escape-bytea.php' class='function' rel='rdfs-seeAlso'>pg_escape_bytea()</a> - Escape a string for insertion into a bytea field</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-escape-string.php' class='function' rel='rdfs-seeAlso'>pg_escape_string()</a> - Escape a string for insertion into a text field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_tty" value="<div id='function.pg-tty' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-tty.php'>pg_tty</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_tty</span> &amp;mdash; <span class='dc-title'> Return the TTY name associated with the connection </span></p> </div> <a name='function.pg-tty.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_tty</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_tty()</b> returns the TTY name that server side debugging output is sent to on the given PostgreSQL <i><tt class='parameter'>connection</tt></i> resource. </p> <blockquote><p><b class='note'>Note</b>: <b>pg_tty()</b> is obsolete, since the server no longer pays attention to the TTY setting, but the function remains for backwards compatibility. <br /> </p></blockquote> </div> <a name='function.pg-tty.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-tty.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the debug TTY of the <i><tt class='parameter'>connection</tt></i> , or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-tty.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_tty()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Server&amp;nbsp;debug&amp;nbsp;TTY&amp;nbsp;is:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_tty</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_transaction_status" value="<div id='function.pg-transaction-status' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-transaction-status.php'>pg_transaction_status</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_transaction_status</span> &amp;mdash; <span class='dc-title'>Returns the current in-transaction status of the server.</span></p> </div> <a name='function.pg-transaction-status.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>pg_transaction_status</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Returns the current in-transaction status of the server. </p> <div class='caution'><b class='caution'>Caution</b> <p class='para'> <b>pg_transaction_status()</b> will give incorrect results when using a PostgreSQL 7.3 server that has the parameter <i>autocommit</i> set to off. The server-side autocommit feature has been deprecated and does not exist in later server versions. </p> </div> </div> <a name='function.pg-transaction-status.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-transaction-status.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>The status can be <b><tt class='constant'>PGSQL_TRANSACTION_IDLE</tt></b> (currently idle), <b><tt class='constant'>PGSQL_TRANSACTION_ACTIVE</tt></b> (a command is in progress), <b><tt class='constant'>PGSQL_TRANSACTION_INTRANS</tt></b> (idle, in a valid transaction block), or <b><tt class='constant'>PGSQL_TRANSACTION_INERROR</tt></b> (idle, in a failed transaction block). <b><tt class='constant'>PGSQL_TRANSACTION_UNKNOWN</tt></b> is reported if the connection is bad. <b><tt class='constant'>PGSQL_TRANSACTION_ACTIVE</tt></b> is reported only when a query has been sent to the server and not yet completed. </p> </div> <a name='function.pg-transaction-status.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_transaction_status()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stat&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_transaction_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$stat&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_TRANSACTION_UNKNOWN</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;is&amp;nbsp;bad'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$stat&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_TRANSACTION_IDLE</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;is&amp;nbsp;currently&amp;nbsp;idle'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;is&amp;nbsp;in&amp;nbsp;a&amp;nbsp;transaction&amp;nbsp;state'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_trace" value="<div id='function.pg-trace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-trace.php'>pg_trace</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.1, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_trace</span> &amp;mdash; <span class='dc-title'>Enable tracing a PostgreSQL connection</span></p> </div> <a name='function.pg-trace.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_trace</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pathname</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mode</tt><span class='initializer'> = &amp;quot;w&amp;quot;</span></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>pg_trace()</b> enables tracing of the PostgreSQL frontend/backend communication to a file. To fully understand the results, one needs to be familiar with the internals of PostgreSQL communication protocol. </p> <p class='para'>For those who are not, it can still be useful for tracing errors in queries sent to the server, you could do for example <strong class='command'>grep &amp;#039;^To backend&amp;#039; trace.log</strong> and see what queries actually were sent to the PostgreSQL server. For more information, refer to the <a href='http://www.postgresql.org/docs/current/interactive/' class='link external'>&amp;raquo; PostgreSQL Documentation</a>. </p> </div> <a name='function.pg-trace.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'>pathname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The full path and file name of the file in which to write the trace log. Same as in <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pathname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional file access mode, same as for <a href='http://www.php.net/manual/en/function.fopen.php' class='function'>fopen()</a>. Defaults to &amp;quot;w&amp;quot;. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-trace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-trace.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_trace()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_trace</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'/tmp/trace.log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_untrace</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Now&amp;nbsp;/tmp/trace.log&amp;nbsp;will&amp;nbsp;contain&amp;nbsp;backend&amp;nbsp;communication<br /></span><span style='color: #007700'>}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-trace.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.fopen.php' class='function' rel='rdfs-seeAlso'>fopen()</a> - Opens file or URL</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-untrace.php' class='function' rel='rdfs-seeAlso'>pg_untrace()</a> - Disable tracing of a PostgreSQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_set_error_verbosity" value="<div id='function.pg-set-error-verbosity' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-set-error-verbosity.php'>pg_set_error_verbosity</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_set_error_verbosity</span> &amp;mdash; <span class='dc-title'> Determines the verbosity of messages returned by <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a> and <a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function'>pg_result_error()</a>. </span></p> </div> <a name='function.pg-set-error-verbosity.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>pg_set_error_verbosity</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$verbosity</tt></span> )</div> <p class='para rdfs-comment'> Determines the verbosity of messages returned by <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a> and <a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function'>pg_result_error()</a>. </p> <p class='para'> <b>pg_set_error_verbosity()</b> sets the verbosity mode, returning the connection&amp;#039;s previous setting. In <b><tt class='constant'>PGSQL_ERRORS_TERSE</tt></b> mode, returned messages include severity, primary text, and position only; this will normally fit on a single line. The default mode (<b><tt class='constant'>PGSQL_ERRORS_DEFAULT</tt></b>) produces messages that include the above plus any detail, hint, or context fields (these may span multiple lines). The <b><tt class='constant'>PGSQL_ERRORS_VERBOSE</tt></b> mode includes all available fields. Changing the verbosity does not affect the messages available from already-existing result objects, only subsequently-created ones. </p> </div> <a name='function.pg-set-error-verbosity.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>verbosity</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The required verbosity: <b><tt class='constant'>PGSQL_ERRORS_TERSE</tt></b>, <b><tt class='constant'>PGSQL_ERRORS_DEFAULT</tt></b> or <b><tt class='constant'>PGSQL_ERRORS_VERBOSE</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-set-error-verbosity.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The previous verbosity level: <b><tt class='constant'>PGSQL_ERRORS_TERSE</tt></b>, <b><tt class='constant'>PGSQL_ERRORS_DEFAULT</tt></b> or <b><tt class='constant'>PGSQL_ERRORS_VERBOSE</tt></b>. </p> </div> <a name='function.pg-set-error-verbosity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_set_error_verbosity()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;doesnotexist;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_set_error_verbosity</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_ERRORS_VERBOSE</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_result_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-set-error-verbosity.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function' rel='rdfs-seeAlso'>pg_last_error()</a> - Get the last error message string of a connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function' rel='rdfs-seeAlso'>pg_result_error()</a> - Get error message associated with result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_set_client_encoding" value="<div id='function.pg-set-client-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-set-client-encoding.php'>pg_set_client_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_set_client_encoding</span> &amp;mdash; <span class='dc-title'> Set the client encoding </span></p> </div> <a name='function.pg-set-client-encoding.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>pg_set_client_encoding</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$encoding</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_set_client_encoding()</b> sets the client encoding and returns 0 if success or -1 if error. </p> <p class='para'> PostgreSQL will automatically convert data in the backend database encoding into the frontend encoding. </p> <blockquote><p><b class='note'>Note</b>: The function used to be called <b>pg_setclientencoding()</b>. <br /> </p></blockquote> </div> <a name='function.pg-set-client-encoding.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>encoding</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The required client encoding. One of <i>SQL_ASCII</i>, <i>EUC_JP</i>, <i>EUC_CN</i>, <i>EUC_KR</i>, <i>EUC_TW</i>, <i>UNICODE</i>, <i>MULE_INTERNAL</i>, <i>LATINX</i> (X=1...9), <i>KOI8</i>, <i>WIN</i>, <i>ALT</i>, <i>SJIS</i>, <i>BIG5</i> or <i>WIN1250</i>. </p> <p class='para'> The exact list of available encodings depends on your PostgreSQL version, so check your PostgreSQL manual for a more specific list. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-set-client-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns 0 on success or -1 on error. </p> </div> <a name='function.pg-set-client-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_set_client_encoding()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;client&amp;nbsp;encoding&amp;nbsp;to&amp;nbsp;UNICODE.&amp;nbsp;&amp;nbsp;Data&amp;nbsp;will&amp;nbsp;be&amp;nbsp;automatically<br />//&amp;nbsp;converted&amp;nbsp;from&amp;nbsp;the&amp;nbsp;backend&amp;nbsp;encoding&amp;nbsp;to&amp;nbsp;the&amp;nbsp;frontend.<br /></span><span style='color: #0000BB'>pg_set_client_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'UNICODE'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Write&amp;nbsp;out&amp;nbsp;UTF-8&amp;nbsp;data<br /></span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Author:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;E-mail:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-set-client-encoding.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-client-encoding.php' class='function' rel='rdfs-seeAlso'>pg_client_encoding()</a> - Gets the client encoding</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_send_query_params" value="<div id='function.pg-send-query-params' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-send-query-params.php'>pg_send_query_params</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_send_query_params</span> &amp;mdash; <span class='dc-title'>Submits a command and separate parameters to the server without waiting for the result(s).</span></p> </div> <a name='function.pg-send-query-params.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_send_query_params</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> )</div> <p class='para rdfs-comment'> Submits a command and separate parameters to the server without waiting for the result(s). </p> <p class='para'> This is equivalent to <a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a> except that query parameters can be specified separately from the <i><tt class='parameter'>query</tt></i> string. The function&amp;#039;s parameters are handled identically to <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a>. Like <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a>, it will not work on pre-7.4 PostgreSQL connections, and it allows only one command in the query string. </p> </div> <a name='function.pg-send-query-params.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameterized SQL statement. Must contain only a single statement. (multiple statements separated by semi-colons are not allowed.) If any parameters are used, they are referred to as $1, $2, etc. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of parameter values to substitute for the $1, $2, etc. placeholders in the original prepared query string. The number of elements in the array must match the number of placeholders. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-send-query-params.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure.</p> <p class='para'> Use <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to determine the query result. </p> </div> <a name='function.pg-send-query-params.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_send_query_params()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Using&amp;nbsp;parameters.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to&amp;nbsp;quote&amp;nbsp;or&amp;nbsp;escape<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;the&amp;nbsp;parameter.<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query_params</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;count(*)&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;city&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Perth'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Compare&amp;nbsp;against&amp;nbsp;basic&amp;nbsp;pg_send_query&amp;nbsp;usage<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_escape_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Perth'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;count(*)&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;city&amp;nbsp;=&amp;nbsp;'</span><span style='color: #007700'>${</span><span style='color: #0000BB'>str</span><span style='color: #007700'>}</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-send-query-params.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function' rel='rdfs-seeAlso'>pg_send_query()</a> - Sends asynchronous query</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_send_query" value="<div id='function.pg-send-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-send-query.php'>pg_send_query</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_send_query</span> &amp;mdash; <span class='dc-title'> Sends asynchronous query </span></p> </div> <a name='function.pg-send-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_send_query</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_send_query()</b> sends a query or queries asynchronously to the <i><tt class='parameter'>connection</tt></i> . Unlike <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, it can send multiple queries at once to PostgreSQL and get the results one by one using <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a>. </p> <p class='para'> Script execution is not blocked while the queries are executing. Use <a href='http://www.php.net/manual/en/function.pg-connection-busy.php' class='function'>pg_connection_busy()</a> to check if the connection is busy (i.e. the query is executing). Queries may be cancelled using <a href='http://www.php.net/manual/en/function.pg-cancel-query.php' class='function'>pg_cancel_query()</a>. </p> <p class='para'> Although the user can send multiple queries at once, multiple queries cannot be sent over a busy connection. If a query is sent while the connection is busy, it waits until the last query is finished and discards all its results. </p> </div> <a name='function.pg-send-query.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The SQL statement or statements to be executed. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/function.pg-escape-string.php' class='link'>properly escaped</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-send-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure.</p> <p class='para'> Use <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to determine the query result. </p> </div> <a name='function.pg-send-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_send_query()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors;&amp;nbsp;select&amp;nbsp;count(*)&amp;nbsp;from&amp;nbsp;authors;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'First&amp;nbsp;call&amp;nbsp;to&amp;nbsp;pg_get_result():&amp;nbsp;</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>&amp;nbsp;has&amp;nbsp;</span><span style='color: #0000BB'>$rows1</span><span style='color: #DD0000'>&amp;nbsp;records\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Second&amp;nbsp;call&amp;nbsp;to&amp;nbsp;pg_get_result():&amp;nbsp;</span><span style='color: #0000BB'>$res2</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res2</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$res2</span><span style='color: #DD0000'>&amp;nbsp;has&amp;nbsp;</span><span style='color: #0000BB'>$rows2</span><span style='color: #DD0000'>&amp;nbsp;records\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> First call to pg_get_result(): Resource id #3 Resource id #3 has 3 records Second call to pg_get_result(): Resource id #4 Resource id #4 has 1 records </pre></div> </div> </div><p> </p> </div> <a name='function.pg-send-query.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-cancel-query.php' class='function' rel='rdfs-seeAlso'>pg_cancel_query()</a> - Cancel an asynchronous query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function' rel='rdfs-seeAlso'>pg_get_result()</a> - Get asynchronous query result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-busy.php' class='function' rel='rdfs-seeAlso'>pg_connection_busy()</a> - Get connection is busy or not</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_send_prepare" value="<div id='function.pg-send-prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-send-prepare.php'>pg_send_prepare</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_send_prepare</span> &amp;mdash; <span class='dc-title'>Sends a request to create a prepared statement with the given parameters, without waiting for completion.</span></p> </div> <a name='function.pg-send-prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_send_prepare</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$stmtname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Sends a request to create a prepared statement with the given parameters, without waiting for completion. </p> <p class='para'> This is an asynchronous version of <a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function'>pg_prepare()</a>: it returns <b><tt class='constant'>TRUE</tt></b> if it was able to dispatch the request, and <b><tt class='constant'>FALSE</tt></b> if not. After a successful call, call <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to determine whether the server successfully created the prepared statement. The function&amp;#039;s parameters are handled identically to <a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function'>pg_prepare()</a>. Like <a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function'>pg_prepare()</a>, it will not work on pre-7.4 versions of PostgreSQL. </p> </div> <a name='function.pg-send-prepare.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>stmtname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name to give the prepared statement. Must be unique per-connection. If &amp;quot;&amp;quot; is specified, then an unnamed statement is created, overwriting any previously defined unnamed statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameterized SQL statement. Must contain only a single statement. (multiple statements separated by semi-colons are not allowed.) If any parameters are used, they are referred to as $1, $2, etc. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-send-prepare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>Returns <b><tt class='constant'>TRUE</tt></b> on success, <b><tt class='constant'>FALSE</tt></b> on failure. Use <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to determine the query result.</p> </div> <a name='function.pg-send-prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_send_prepare()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prepare&amp;nbsp;a&amp;nbsp;query&amp;nbsp;for&amp;nbsp;execution<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;prepared&amp;nbsp;query.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to&amp;nbsp;escape<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;the&amp;nbsp;string&amp;nbsp;'Joe's&amp;nbsp;Widgets'&amp;nbsp;in&amp;nbsp;any&amp;nbsp;way<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;same&amp;nbsp;prepared&amp;nbsp;query,&amp;nbsp;this&amp;nbsp;time&amp;nbsp;with&amp;nbsp;a&amp;nbsp;different&amp;nbsp;parameter<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Clothes&amp;nbsp;Clothes&amp;nbsp;Clothes'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-send-prepare.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function' rel='rdfs-seeAlso'>pg_pconnect()</a> - Open a persistent PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-execute.php' class='function' rel='rdfs-seeAlso'>pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-execute.php' class='function' rel='rdfs-seeAlso'>pg_send_execute()</a> - Sends a request to execute a prepared statement with given parameters, without waiting for the result(s).</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-query-params.php' class='function' rel='rdfs-seeAlso'>pg_send_query_params()</a> - Submits a command and separate parameters to the server without waiting for the result(s).</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_send_execute" value="<div id='function.pg-send-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-send-execute.php'>pg_send_execute</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_send_execute</span> &amp;mdash; <span class='dc-title'>Sends a request to execute a prepared statement with given parameters, without waiting for the result(s).</span></p> </div> <a name='function.pg-send-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_send_execute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$stmtname</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> )</div> <p class='para rdfs-comment'> Sends a request to execute a prepared statement with given parameters, without waiting for the result(s). </p> <p class='para'> This is similar to <a href='http://www.php.net/manual/en/function.pg-send-query-params.php' class='function'>pg_send_query_params()</a>, but the command to be executed is specified by naming a previously-prepared statement, instead of giving a query string. The function&amp;#039;s parameters are handled identically to <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a>. Like <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a>, it will not work on pre-7.4 versions of PostgreSQL. </p> </div> <a name='function.pg-send-execute.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>stmtname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the prepared statement to execute. if &amp;quot;&amp;quot; is specified, then the unnamed statement is executed. The name must have been previously prepared using <a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function'>pg_prepare()</a>, <a href='http://www.php.net/manual/en/function.pg-send-prepare.php' class='function'>pg_send_prepare()</a> or a <i>PREPARE</i> SQL command. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of parameter values to substitute for the $1, $2, etc. placeholders in the original prepared query string. The number of elements in the array must match the number of placeholders. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-send-execute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>Returns <b><tt class='constant'>TRUE</tt></b> on success, <b><tt class='constant'>FALSE</tt></b> on failure. Use <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to determine the query result.</p> </div> <a name='function.pg-send-execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_send_execute()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Prepare&amp;nbsp;a&amp;nbsp;query&amp;nbsp;for&amp;nbsp;execution<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;prepared&amp;nbsp;query.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to&amp;nbsp;escape<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;the&amp;nbsp;string&amp;nbsp;'Joe's&amp;nbsp;Widgets'&amp;nbsp;in&amp;nbsp;any&amp;nbsp;way<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;same&amp;nbsp;prepared&amp;nbsp;query,&amp;nbsp;this&amp;nbsp;time&amp;nbsp;with&amp;nbsp;a&amp;nbsp;different&amp;nbsp;parameter<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Clothes&amp;nbsp;Clothes&amp;nbsp;Clothes'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-send-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function' rel='rdfs-seeAlso'>pg_prepare()</a> - Submits a request to create a prepared statement with the given parameters, and waits for completion.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-prepare.php' class='function' rel='rdfs-seeAlso'>pg_send_prepare()</a> - Sends a request to create a prepared statement with the given parameters, without waiting for completion.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-execute.php' class='function' rel='rdfs-seeAlso'>pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_select" value="<div id='function.pg-select' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-select.php'>pg_select</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_select</span> &amp;mdash; <span class='dc-title'> Select records </span></p> </div> <a name='function.pg-select.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_select</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$assoc_array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = PGSQL_DML_EXEC</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_select()</b> selects records specified by <i>assoc_array</i> which has <i>field=&amp;gt;value</i>. For a successful query, it returns an array containing all records and fields that match the condition specified by <i>assoc_array</i>. </p> <p class='para'>If <i>options</i> is specified, <a href='http://www.php.net/manual/en/function.pg-convert.php' class='function'>pg_convert()</a> is applied to <i>assoc_array</i> with the specified flags. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-select.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table from which to select rows. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>assoc_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> whose keys are field names in the table <i><tt class='parameter'>table_name</tt></i> , and whose values are the conditions that a row must meet to be retrieved. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Any number of <b><tt class='constant'>PGSQL_CONV_FORCE_NULL</tt></b>, <b><tt class='constant'>PGSQL_DML_NO_CONV</tt></b>, <b><tt class='constant'>PGSQL_DML_EXEC</tt></b>, <b><tt class='constant'>PGSQL_DML_ASYNC</tt></b> or <b><tt class='constant'>PGSQL_DML_STRING</tt></b> combined. If <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is part of the <i><tt class='parameter'>options</tt></i> then query string is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-select.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. Returns <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is passed via <i><tt class='parameter'>options</tt></i> . </p> </div> <a name='function.pg-select.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_select()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;safe,&amp;nbsp;since&amp;nbsp;$_POST&amp;nbsp;is&amp;nbsp;converted&amp;nbsp;automatically<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rec&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_select</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'post_log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$rec</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Records&amp;nbsp;selected\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$rec</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;must&amp;nbsp;have&amp;nbsp;sent&amp;nbsp;wrong&amp;nbsp;inputs\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-select.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-convert.php' class='function' rel='rdfs-seeAlso'>pg_convert()</a> - Convert associative array values into suitable for SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_result_status" value="<div id='function.pg-result-status' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-result-status.php'>pg_result_status</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_result_status</span> &amp;mdash; <span class='dc-title'> Get status of query result </span></p> </div> <a name='function.pg-result-status.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_result_status</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'>$type</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_result_status()</b> returns the status of a result resource, or the PostgreSQL command completion tag associated with the result </p> </div> <a name='function.pg-result-status.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Either <b><tt class='constant'>PGSQL_STATUS_LONG</tt></b> to return the numeric status of the <i><tt class='parameter'>result</tt></i> , or <b><tt class='constant'>PGSQL_STATUS_STRING</tt></b> to return the command tag of the <i><tt class='parameter'>result</tt></i> . If not specified, <b><tt class='constant'>PGSQL_STATUS_LONG</tt></b> is the default. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-result-status.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Possible return values are <b><tt class='constant'>PGSQL_EMPTY_QUERY</tt></b>, <b><tt class='constant'>PGSQL_COMMAND_OK</tt></b>, <b><tt class='constant'>PGSQL_TUPLES_OK</tt></b>, <b><tt class='constant'>PGSQL_COPY_OUT</tt></b>, <b><tt class='constant'>PGSQL_COPY_IN</tt></b>, <b><tt class='constant'>PGSQL_BAD_RESPONSE</tt></b>, <b><tt class='constant'>PGSQL_NONFATAL_ERROR</tt></b> and <b><tt class='constant'>PGSQL_FATAL_ERROR</tt></b> if <b><tt class='constant'>PGSQL_STATUS_LONG</tt></b> is specified. Otherwise, a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the PostgreSQL command tag is returned. </p> </div> <a name='function.pg-result-status.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The <i><tt class='parameter'>type</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-result-status.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_result_status()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;a&amp;nbsp;COPY<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'COPY&amp;nbsp;authors&amp;nbsp;FROM&amp;nbsp;STDIN;'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;the&amp;nbsp;result&amp;nbsp;status<br /></span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_result_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Determine&amp;nbsp;status<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$status&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_COPY_IN</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Copy&amp;nbsp;began.'</span><span style='color: #007700'>;<br />else<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Copy&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Copy began. </pre></div> </div> </div><p> </p> </div> <a name='function.pg-result-status.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-status.php' class='function' rel='rdfs-seeAlso'>pg_connection_status()</a> - Get connection status</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_result_seek" value="<div id='function.pg-result-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-result-seek.php'>pg_result_seek</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_result_seek</span> &amp;mdash; <span class='dc-title'>Set internal row offset in result resource</span></p> </div> <a name='function.pg-result-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_result_seek</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> )</div> <p class='para rdfs-comment'> <b>pg_result_seek()</b> sets the internal row offset in a result resource. </p> </div> <a name='function.pg-result-seek.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row to move the internal offset to in the <i><tt class='parameter'>result</tt></i> resource. Rows are numbered starting from zero. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-result-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-result-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_result_seek()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;a&amp;nbsp;query<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Seek&amp;nbsp;to&amp;nbsp;the&amp;nbsp;3rd&amp;nbsp;row&amp;nbsp;(assuming&amp;nbsp;there&amp;nbsp;are&amp;nbsp;3&amp;nbsp;rows)<br /></span><span style='color: #0000BB'>pg_result_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;the&amp;nbsp;3rd&amp;nbsp;row<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-result-seek.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function' rel='rdfs-seeAlso'>pg_fetch_row()</a> - Get a row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>pg_fetch_assoc()</a> - Fetch a row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_result_error_field" value="<div id='function.pg-result-error-field' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-result-error-field.php'>pg_result_error_field</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_result_error_field</span> &amp;mdash; <span class='dc-title'>Returns an individual field of an error report.</span></p> </div> <a name='function.pg-result-error-field.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_result_error_field</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'>$fieldcode</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_result_error_field()</b> returns one of the detailed error message fields associated with <i><tt class='parameter'>result</tt></i> resource. It is only available against a PostgreSQL 7.4 or above server. The error field is specified by the <i><tt class='parameter'>fieldcode</tt></i> . </p> <p class='para'> Because <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a> and <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> return <b><tt class='constant'>FALSE</tt></b> if the query fails, you must use <a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a> and <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to get the result handle. </p> <p class='para'> If you need to get additional error information from failed <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a> queries, use <a href='http://www.php.net/manual/en/function.pg-set-error-verbosity.php' class='function'>pg_set_error_verbosity()</a> and <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a> and then parse the result. </p> </div> <a name='function.pg-result-error-field.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'> A PostgreSQL query result resource from a previously executed statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fieldcode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Possible <i><tt class='parameter'>fieldcode</tt></i> values are: <b><tt class='constant'>PGSQL_DIAG_SEVERITY</tt></b>, <b><tt class='constant'>PGSQL_DIAG_SQLSTATE</tt></b>, <b><tt class='constant'>PGSQL_DIAG_MESSAGE_PRIMARY</tt></b>, <b><tt class='constant'>PGSQL_DIAG_MESSAGE_DETAIL</tt></b>, <b><tt class='constant'>PGSQL_DIAG_MESSAGE_HINT</tt></b>, <b><tt class='constant'>PGSQL_DIAG_STATEMENT_POSITION</tt></b>, <b><tt class='constant'>PGSQL_DIAG_INTERNAL_POSITION</tt></b> (PostgreSQL 8.0+ only), <b><tt class='constant'>PGSQL_DIAG_INTERNAL_QUERY</tt></b> (PostgreSQL 8.0+ only), <b><tt class='constant'>PGSQL_DIAG_CONTEXT</tt></b>, <b><tt class='constant'>PGSQL_DIAG_SOURCE_FILE</tt></b>, <b><tt class='constant'>PGSQL_DIAG_SOURCE_LINE</tt></b> or <b><tt class='constant'>PGSQL_DIAG_SOURCE_FUNCTION</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-result-error-field.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the contents of the error field, <b><tt class='constant'>NULL</tt></b> if the field does not exist or <b><tt class='constant'>FALSE</tt></b> on failure.</p> </div> <a name='function.pg-result-error-field.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_result_error_field()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;doesnotexist;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_result_error_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_DIAG_SQLSTATE</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-result-error-field.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function' rel='rdfs-seeAlso'>pg_result_error()</a> - Get error message associated with result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_result_error" value="<div id='function.pg-result-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-result-error.php'>pg_result_error</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_result_error</span> &amp;mdash; <span class='dc-title'> Get error message associated with result </span></p> </div> <a name='function.pg-result-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_result_error</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_result_error()</b> returns any error message associated with the <i><tt class='parameter'>result</tt></i> resource. Therefore, the user has a better chance of getting the correct error message than with <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a>. </p> <p class='para'> The function <a href='http://www.php.net/manual/en/function.pg-result-error-field.php' class='function'>pg_result_error_field()</a> can give much greater detail on result errors than <b>pg_result_error()</b>. </p> <p class='para'> Because <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a> returns <b><tt class='constant'>FALSE</tt></b> if the query fails, you must use <a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a> and <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> to get the result handle. </p> </div> <a name='function.pg-result-error.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-result-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if there is an error associated with the <i><tt class='parameter'>result</tt></i> parameter, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.pg-result-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_result_error()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;doesnotexist;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_result_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-result-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-error-field.php' class='function' rel='rdfs-seeAlso'>pg_result_error_field()</a> - Returns an individual field of an error report.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function' rel='rdfs-seeAlso'>pg_send_query()</a> - Sends asynchronous query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function' rel='rdfs-seeAlso'>pg_get_result()</a> - Get asynchronous query result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function' rel='rdfs-seeAlso'>pg_last_error()</a> - Get the last error message string of a connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-last-notice.php' class='function' rel='rdfs-seeAlso'>pg_last_notice()</a> - Returns the last notice message from PostgreSQL server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_query_params" value="<div id='function.pg-query-params' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-query-params.php'>pg_query_params</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_query_params</span> &amp;mdash; <span class='dc-title'>Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.</span></p> </div> <a name='function.pg-query-params.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_query_params</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> )</div> <p class='para rdfs-comment'> Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text. </p> <p class='para'> <b>pg_query_params()</b> is like <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, but offers additional functionality: parameter values can be specified separately from the command string proper. <b>pg_query_params()</b> is supported only against PostgreSQL 7.4 or higher connections; it will fail when using earlier versions. </p> <p class='para'> If parameters are used, they are referred to in the <i><tt class='parameter'>query</tt></i> string as $1, $2, etc. <i><tt class='parameter'>params</tt></i> specifies the actual values of the parameters. A <b><tt class='constant'>NULL</tt></b> value in this array means the corresponding parameter is SQL <i>NULL</i>. </p> <p class='para'> The primary advantage of <b>pg_query_params()</b> over <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a> is that parameter values may be separated from the <i><tt class='parameter'>query</tt></i> string, thus avoiding the need for tedious and error-prone quoting and escaping. Unlike <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <b>pg_query_params()</b> allows at most one SQL command in the given string. (There can be semicolons in it, but not more than one nonempty command.) </p> </div> <a name='function.pg-query-params.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameterized SQL statement. Must contain only a single statement. (multiple statements separated by semi-colons are not allowed.) If any parameters are used, they are referred to as $1, $2, etc. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of parameter values to substitute for the $1, $2, etc. placeholders in the original prepared query string. The number of elements in the array must match the number of placeholders. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-query-params.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A query result resource on success, or <b><tt class='constant'>FALSE</tt></b> on failure.</p> </div> <a name='function.pg-query-params.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_query_params()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'<br /></span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mary'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Find&amp;nbsp;all&amp;nbsp;shops&amp;nbsp;named&amp;nbsp;Joe's&amp;nbsp;Widgets.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to<br />//&amp;nbsp;escape&amp;nbsp;'Joe's&amp;nbsp;Widgets'<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query_params</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Compare&amp;nbsp;against&amp;nbsp;just&amp;nbsp;using&amp;nbsp;pg_query<br /></span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_escape_string</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>}</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-query-params.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_query" value="<div id='function.pg-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-query.php'>pg_query</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_query</span> &amp;mdash; <span class='dc-title'>Execute a query</span></p> </div> <a name='function.pg-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_query</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_query()</b> executes the <i><tt class='parameter'>query</tt></i> on the specified database <i><tt class='parameter'>connection</tt></i> . </p> <p class='para'> If an error occurs, and <b><tt class='constant'>FALSE</tt></b> is returned, details of the error can be retrieved using the <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a> function if the connection is valid. </p> <p class='para'> </p><blockquote><p><b class='note'>Note</b>: <span class='simpara'> Although <i><tt class='parameter'>connection</tt></i> can be omitted, it is not recommended, since it can be the cause of hard to find bugs in scripts. </span> </p></blockquote><p> </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_exec()</b>. <b>pg_exec()</b> is still available for compatibility reasons, but users are encouraged to use the newer name. <br /> </p></blockquote> </div> <a name='function.pg-query.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The SQL statement or statements to be executed. When multiple statements are passed to the function, they are automatically executed as one transaction, unless there are explicit BEGIN/COMMIT commands included in the query string. However, using multiple transactions in one function call is not recommended. </p> <p class='para'> Data inside the query should be <a href='http://www.php.net/manual/en/function.pg-escape-string.php' class='link'>properly escaped</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A query result resource on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_query()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Author:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;E-mail:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Using <b>pg_query()</b> with multiple statements</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;these&amp;nbsp;statements&amp;nbsp;will&amp;nbsp;be&amp;nbsp;executed&amp;nbsp;as&amp;nbsp;one&amp;nbsp;transaction<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;authors&amp;nbsp;SET&amp;nbsp;author=UPPER(author)&amp;nbsp;WHERE&amp;nbsp;id=1;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;authors&amp;nbsp;SET&amp;nbsp;author=LOWER(author)&amp;nbsp;WHERE&amp;nbsp;id=2;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UPDATE&amp;nbsp;authors&amp;nbsp;SET&amp;nbsp;author=NULL&amp;nbsp;WHERE&amp;nbsp;id=3;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-query.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function' rel='rdfs-seeAlso'>pg_pconnect()</a> - Open a persistent PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-num-rows.php' class='function' rel='rdfs-seeAlso'>pg_num_rows()</a> - Returns the number of rows in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-affected-rows.php' class='function' rel='rdfs-seeAlso'>pg_affected_rows()</a> - Returns number of affected records (tuples)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_put_line" value="<div id='function.pg-put-line' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-put-line.php'>pg_put_line</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_put_line</span> &amp;mdash; <span class='dc-title'>Send a NULL-terminated string to PostgreSQL backend</span></p> </div> <a name='function.pg-put-line.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_put_line</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_put_line()</b> sends a NULL-terminated string to the PostgreSQL backend server. This is needed in conjunction with PostgreSQL&amp;#039;s <i>COPY FROM</i> command. </p> <p class='para'><i>COPY</i> is a high-speed data loading interface supported by PostgreSQL. Data is passed in without being parsed, and in a single transaction. </p> <p class='para'> An alternative to using raw <b>pg_put_line()</b> commands is to use <a href='http://www.php.net/manual/en/function.pg-copy-from.php' class='function'>pg_copy_from()</a>. This is a far simpler interface. </p> <blockquote><p><b class='note'>Note</b>: The application must explicitly send the two characters &amp;quot;\.&amp;quot; on the last line to indicate to the backend that it has finished sending its data, before issuing <a href='http://www.php.net/manual/en/function.pg-end-copy.php' class='function'>pg_end_copy()</a>. <br /> </p></blockquote> <div class='warning'><b class='warning'>Warning</b> <p class='para'> Use of the <b>pg_put_line()</b> causes most large object operations, including <a href='http://www.php.net/manual/en/function.pg-lo-read.php' class='function'>pg_lo_read()</a> and <a href='http://www.php.net/manual/en/function.pg-lo-tell.php' class='function'>pg_lo_tell()</a>, to subsequently fail. You can use <a href='http://www.php.net/manual/en/function.pg-copy-from.php' class='function'>pg_copy_from()</a> and <a href='http://www.php.net/manual/en/function.pg-copy-to.php' class='function'>pg_copy_to()</a> instead. </p> </div> </div> <a name='function.pg-put-line.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A line of text to be sent directly to the PostgreSQL backend. A <i>NULL</i> terminator is added automatically. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-put-line.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-put-line.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_put_line()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'create&amp;nbsp;table&amp;nbsp;bar&amp;nbsp;(a&amp;nbsp;int4,&amp;nbsp;b&amp;nbsp;char(16),&amp;nbsp;d&amp;nbsp;float8)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'copy&amp;nbsp;bar&amp;nbsp;from&amp;nbsp;stdin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3\thello&amp;nbsp;world\t4.5\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4\tgoodbye&amp;nbsp;world\t7.11\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\\.\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_end_copy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-put-line.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-end-copy.php' class='function' rel='rdfs-seeAlso'>pg_end_copy()</a> - Sync with PostgreSQL backend</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_prepare" value="<div id='function.pg-prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-prepare.php'>pg_prepare</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_prepare</span> &amp;mdash; <span class='dc-title'> Submits a request to create a prepared statement with the given parameters, and waits for completion.</span></p> </div> <a name='function.pg-prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_prepare</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$stmtname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_prepare()</b> creates a prepared statement for later execution with <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> or <a href='http://www.php.net/manual/en/function.pg-send-execute.php' class='function'>pg_send_execute()</a>. This feature allows commands that will be used repeatedly to be parsed and planned just once, rather than each time they are executed. <b>pg_prepare()</b> is supported only against PostgreSQL 7.4 or higher connections; it will fail when using earlier versions. </p> <p class='para'> The function creates a prepared statement named <i><tt class='parameter'>stmtname</tt></i> from the <i><tt class='parameter'>query</tt></i> string, which must contain a single SQL command. <i><tt class='parameter'>stmtname</tt></i> may be &amp;quot;&amp;quot; to create an unnamed statement, in which case any pre-existing unnamed statement is automatically replaced; otherwise it is an error if the statement name is already defined in the current session. If any parameters are used, they are referred to in the <i><tt class='parameter'>query</tt></i> as $1, $2, etc. </p> <p class='para'> Prepared statements for use with <b>pg_prepare()</b> can also be created by executing SQL <i>PREPARE</i> statements. (But <b>pg_prepare()</b> is more flexible since it does not require parameter types to be pre-specified.) Also, although there is no PHP function for deleting a prepared statement, the SQL <i>DEALLOCATE</i> statement can be used for that purpose. </p> </div> <a name='function.pg-prepare.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>stmtname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name to give the prepared statement. Must be unique per-connection. If &amp;quot;&amp;quot; is specified, then an unnamed statement is created, overwriting any previously defined unnamed statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameterized SQL statement. Must contain only a single statement. (multiple statements separated by semi-colons are not allowed.) If any parameters are used, they are referred to as $1, $2, etc. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-prepare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A query result resource on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_prepare()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'<br /></span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mary'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Prepare&amp;nbsp;a&amp;nbsp;query&amp;nbsp;for&amp;nbsp;execution<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;prepared&amp;nbsp;query.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to&amp;nbsp;escape<br />//&amp;nbsp;the&amp;nbsp;string&amp;nbsp;'Joe's&amp;nbsp;Widgets'&amp;nbsp;in&amp;nbsp;any&amp;nbsp;way<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;same&amp;nbsp;prepared&amp;nbsp;query,&amp;nbsp;this&amp;nbsp;time&amp;nbsp;with&amp;nbsp;a&amp;nbsp;different&amp;nbsp;parameter<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Clothes&amp;nbsp;Clothes&amp;nbsp;Clothes'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-prepare.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-execute.php' class='function' rel='rdfs-seeAlso'>pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-execute.php' class='function' rel='rdfs-seeAlso'>pg_send_execute()</a> - Sends a request to execute a prepared statement with given parameters, without waiting for the result(s).</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_port" value="<div id='function.pg-port' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-port.php'>pg_port</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_port</span> &amp;mdash; <span class='dc-title'> Return the port number associated with the connection </span></p> </div> <a name='function.pg-port.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>pg_port</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_port()</b> returns the port number that the given PostgreSQL <i><tt class='parameter'>connection</tt></i> resource is connected to. </p> </div> <a name='function.pg-port.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-port.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> containing the port number of the database server the <i><tt class='parameter'>connection</tt></i> is to, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-port.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_port()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;connected&amp;nbsp;to&amp;nbsp;port:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_port</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_ping" value="<div id='function.pg-ping' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-ping.php'>pg_ping</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_ping</span> &amp;mdash; <span class='dc-title'>Ping database connection</span></p> </div> <a name='function.pg-ping.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_ping</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_ping()</b> pings a database connection and tries to reconnect it if it is broken. </p> </div> <a name='function.pg-ping.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-ping.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-ping.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_ping()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_ping</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Connection&amp;nbsp;is&amp;nbsp;broken\n'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-ping.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-status.php' class='function' rel='rdfs-seeAlso'>pg_connection_status()</a> - Get connection status</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-reset.php' class='function' rel='rdfs-seeAlso'>pg_connection_reset()</a> - Reset connection (reconnect)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_pconnect" value="<div id='function.pg-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-pconnect.php'>pg_pconnect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_pconnect</span> &amp;mdash; <span class='dc-title'>Open a persistent PostgreSQL connection</span></p> </div> <a name='function.pg-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_pconnect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$connection_string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$connect_type</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_pconnect()</b> opens a connection to a PostgreSQL database. It returns a connection resource that is needed by other PostgreSQL functions. </p> <p class='para'> If a second call is made to <b>pg_pconnect()</b> with the same <i><tt class='parameter'>connection_string</tt></i> as an existing connection, the existing connection will be returned unless you pass <b><tt class='constant'>PGSQL_CONNECT_FORCE_NEW</tt></b> as <i><tt class='parameter'>connect_type</tt></i> . </p> <p class='para'> To enable persistent connection, the <a href='http://www.php.net/manual/en/pgsql.configuration.php#ini.pgsql.allow-persistent' class='link'>pgsql.allow_persistent</a> <var class='filename'>php.ini</var> directive must be set to &amp;quot;On&amp;quot; (which is the default). The maximum number of persistent connection can be defined with the <a href='http://www.php.net/manual/en/pgsql.configuration.php#ini.pgsql.max-persistent' class='link'>pgsql.max_persistent</a> <var class='filename'>php.ini</var> directive (defaults to -1 for no limit). The total number of connections can be set with the <a href='http://www.php.net/manual/en/pgsql.configuration.php#ini.pgsql.max-links' class='link'>pgsql.max_links</a> <var class='filename'>php.ini</var> directive. </p> <p class='para'> <a href='http://www.php.net/manual/en/function.pg-close.php' class='function'>pg_close()</a> will not close persistent links generated by <b>pg_pconnect()</b>. </p> </div> <a name='function.pg-pconnect.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'>connection_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>connection_string</tt></i> can be empty to use all default parameters, or it can contain one or more parameter settings separated by whitespace. Each parameter setting is in the form <i>keyword = value</i>. Spaces around the equal sign are optional. To write an empty value or a value containing spaces, surround it with single quotes, e.g., <i>keyword = &amp;#039;a value&amp;#039;</i>. Single quotes and backslashes within the value must be escaped with a backslash, i.e., \&amp;#039; and \\. </p> <p class='para'> The currently recognized parameter keywords are: <i><tt class='parameter'>host</tt></i> , <i><tt class='parameter'>hostaddr</tt></i> , <i><tt class='parameter'>port</tt></i> , <i><tt class='parameter'>dbname</tt></i> , <i><tt class='parameter'>user</tt></i> , <i><tt class='parameter'>password</tt></i> , <i><tt class='parameter'>connect_timeout</tt></i> , <i><tt class='parameter'>options</tt></i> , <i><tt class='parameter'>tty</tt></i> (ignored), <i><tt class='parameter'>sslmode</tt></i> , <i><tt class='parameter'>requiressl</tt></i> (deprecated in favor of <i><tt class='parameter'>sslmode</tt></i> ), and <i><tt class='parameter'>service</tt></i> . Which of these arguments exist depends on your PostgreSQL version. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>connect_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <b><tt class='constant'>PGSQL_CONNECT_FORCE_NEW</tt></b> is passed, then a new connection is created, even if the <i><tt class='parameter'>connection_string</tt></i> is identical to an existing connection. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> PostgreSQL connection resource on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-pconnect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_pconnect()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mary'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'<br /><br /></span><span style='color: #0000BB'>$dbconn2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=mary'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'&amp;nbsp;on&amp;nbsp;'localhost'&amp;nbsp;at&amp;nbsp;port&amp;nbsp;'5432'<br /><br /></span><span style='color: #0000BB'>$dbconn3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=sheep&amp;nbsp;port=5432&amp;nbsp;dbname=mary&amp;nbsp;user=lamb&amp;nbsp;password=foo'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'&amp;nbsp;on&amp;nbsp;the&amp;nbsp;host&amp;nbsp;'sheep'&amp;nbsp;with&amp;nbsp;a&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /><br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'host=sheep&amp;nbsp;port=5432&amp;nbsp;dbname=test&amp;nbsp;user=lamb&amp;nbsp;password=bar'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$dbconn4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'test'&amp;nbsp;on&amp;nbsp;the&amp;nbsp;host&amp;nbsp;'sheep'&amp;nbsp;with&amp;nbsp;a&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-pconnect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> <li class='member'> <a href='http://www.php.net/manual/en/features.persistent-connections.php' class='link'> Persistent Database Connections</a> </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_parameter_status" value="<div id='function.pg-parameter-status' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-parameter-status.php'>pg_parameter_status</a></h1> <p class='verinfo'>(PHP 5)</p><p class='refpurpose'><span class='refname'>pg_parameter_status</span> &amp;mdash; <span class='dc-title'>Looks up a current parameter setting of the server.</span></p> </div> <a name='function.pg-parameter-status.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_parameter_status</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$param_name</tt></span> )</div> <p class='para rdfs-comment'> Looks up a current parameter setting of the server. </p> <p class='para'> Certain parameter values are reported by the server automatically at connection startup or whenever their values change. <b>pg_parameter_status()</b> can be used to interrogate these settings. It returns the current value of a parameter if known, or <b><tt class='constant'>FALSE</tt></b> if the parameter is not known. </p> <p class='para'> Parameters reported as of PostgreSQL 8.0 include <i>server_version</i>, <i>server_encoding</i>, <i>client_encoding</i>, <i>is_superuser</i>, <i>session_authorization</i>, <i>DateStyle</i>, <i>TimeZone</i>, and <i>integer_datetimes</i>. (<i>server_encoding</i>, <i>TimeZone</i>, and <i>integer_datetimes</i> were not reported by releases before 8.0.) Note that <i>server_version</i>, <i>server_encoding</i> and <i>integer_datetimes</i> cannot change after PostgreSQL startup. </p> <p class='para'> PostgreSQL 7.3 or lower servers do not report parameter settings, <b>pg_parameter_status()</b> includes logic to obtain values for <i>server_version</i> and <i>client_encoding</i> anyway. Applications are encouraged to use <b>pg_parameter_status()</b> rather than ad hoc code to determine these values. </p> <div class='caution'><b class='caution'>Caution</b> <p class='para'> On a pre-7.4 PostgreSQL server, changing <i>client_encoding</i> via <i>SET</i> after connection startup will not be reflected by <b>pg_parameter_status()</b>. </p> </div> </div> <a name='function.pg-parameter-status.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>param_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Possible <i><tt class='parameter'>param_name</tt></i> values include <i>server_version</i>, <i>server_encoding</i>, <i>client_encoding</i>, <i>is_superuser</i>, <i>session_authorization</i>, <i>DateStyle</i>, <i>TimeZone</i>, and <i>integer_datetimes</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-parameter-status.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'>A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the value of the parameter, <b><tt class='constant'>FALSE</tt></b> on failure or invalid <i><tt class='parameter'>param_name</tt></i> .</p> </div> <a name='function.pg-parameter-status.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_parameter_status()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Server&amp;nbsp;encoding:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>pg_parameter_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'server_encoding'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Server encoding: SQL_ASCII </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_options" value="<div id='function.pg-options' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-options.php'>pg_options</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_options</span> &amp;mdash; <span class='dc-title'>Get the options associated with the connection</span></p> </div> <a name='function.pg-options.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_options</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_options()</b> will return a string containing the options specified on the given PostgreSQL <i><tt class='parameter'>connection</tt></i> resource. </p> </div> <a name='function.pg-options.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-options.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the <i><tt class='parameter'>connection</tt></i> options, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-options.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_options()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_options</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-options.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_num_rows" value="<div id='function.pg-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-num-rows.php'>pg_num_rows</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_num_rows</span> &amp;mdash; <span class='dc-title'>Returns the number of rows in a result</span></p> </div> <a name='function.pg-num-rows.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>pg_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_num_rows()</b> will return the number of rows in a PostgreSQL result resource. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_numrows()</b>. <br /> </p></blockquote> </div> <a name='function.pg-num-rows.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of rows in the result. On error, -1 is returned. </p> </div> <a name='function.pg-num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_num_rows()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$rows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$rows&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;row(s)&amp;nbsp;returned.\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 row(s) returned. </pre></div> </div> </div><p> </p> </div> <a name='function.pg-num-rows.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-num-fields.php' class='function' rel='rdfs-seeAlso'>pg_num_fields()</a> - Returns the number of fields in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-affected-rows.php' class='function' rel='rdfs-seeAlso'>pg_affected_rows()</a> - Returns number of affected records (tuples)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_num_fields" value="<div id='function.pg-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-num-fields.php'>pg_num_fields</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_num_fields</span> &amp;mdash; <span class='dc-title'>Returns the number of fields in a result</span></p> </div> <a name='function.pg-num-fields.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>pg_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_num_fields()</b> returns the number of fields (columns) in a PostgreSQL result resource. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_numfields()</b>. <br /> </p></blockquote> </div> <a name='function.pg-num-fields.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of fields (columns) in the result. On error, -1 is returned. </p> </div> <a name='function.pg-num-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_num_fields()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1,&amp;nbsp;2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$num&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;field(s)&amp;nbsp;returned.\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 2 field(s) returned. </pre></div> </div> </div><p> </p> </div> <a name='function.pg-num-fields.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-num-rows.php' class='function' rel='rdfs-seeAlso'>pg_num_rows()</a> - Returns the number of rows in a result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-affected-rows.php' class='function' rel='rdfs-seeAlso'>pg_affected_rows()</a> - Returns number of affected records (tuples)</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_meta_data" value="<div id='function.pg-meta-data' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-meta-data.php'>pg_meta_data</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_meta_data</span> &amp;mdash; <span class='dc-title'> Get meta data for table </span></p> </div> <a name='function.pg-meta-data.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_meta_data</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_meta_data()</b> returns table definition for <i>table_name</i> as an array. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-meta-data.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-meta-data.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of the table definition, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-meta-data.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting table metadata</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$meta&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_meta_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'authors'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>is_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;pre&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$meta</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/pre&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> array(3) { [&amp;quot;author&amp;quot;]=&amp;gt; array(5) { [&amp;quot;num&amp;quot;]=&amp;gt; int(1) [&amp;quot;type&amp;quot;]=&amp;gt; string(7) &amp;quot;varchar&amp;quot; [&amp;quot;len&amp;quot;]=&amp;gt; int(-1) [&amp;quot;not null&amp;quot;]=&amp;gt; bool(false) [&amp;quot;has default&amp;quot;]=&amp;gt; bool(false) } [&amp;quot;year&amp;quot;]=&amp;gt; array(5) { [&amp;quot;num&amp;quot;]=&amp;gt; int(2) [&amp;quot;type&amp;quot;]=&amp;gt; string(4) &amp;quot;int2&amp;quot; [&amp;quot;len&amp;quot;]=&amp;gt; int(2) [&amp;quot;not null&amp;quot;]=&amp;gt; bool(false) [&amp;quot;has default&amp;quot;]=&amp;gt; bool(false) } [&amp;quot;title&amp;quot;]=&amp;gt; array(5) { [&amp;quot;num&amp;quot;]=&amp;gt; int(3) [&amp;quot;type&amp;quot;]=&amp;gt; string(7) &amp;quot;varchar&amp;quot; [&amp;quot;len&amp;quot;]=&amp;gt; int(-1) [&amp;quot;not null&amp;quot;]=&amp;gt; bool(false) [&amp;quot;has default&amp;quot;]=&amp;gt; bool(false) } } </pre></div> </div> </div><p> </p> </div> <a name='function.pg-meta-data.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-convert.php' class='function' rel='rdfs-seeAlso'>pg_convert()</a> - Convert associative array values into suitable for SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_write" value="<div id='function.pg-lo-write' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-write.php'>pg_lo_write</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_write</span> &amp;mdash; <span class='dc-title'>Write to a large object</span></p> </div> <a name='function.pg-lo-write.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>pg_lo_write</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_lo_write()</b> writes data into a large object at the current seek position. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_lowrite()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-write.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'>large_object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to be written to the large object. If <i><tt class='parameter'>len</tt></i> is specified and is less than the length of <i><tt class='parameter'>data</tt></i> , only <i><tt class='parameter'>len</tt></i> bytes will be written. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>len</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional maximum number of bytes to write. Must be greater than zero and no greater than the length of <i><tt class='parameter'>data</tt></i> . Defaults to the length of <i><tt class='parameter'>data</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-write.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of bytes written to the large object, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-lo-write.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_write()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$doc_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'This&amp;nbsp;will&amp;nbsp;overwrite&amp;nbsp;the&amp;nbsp;start&amp;nbsp;of&amp;nbsp;the&amp;nbsp;large&amp;nbsp;object.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-write.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-create.php' class='function' rel='rdfs-seeAlso'>pg_lo_create()</a> - Create a large object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function' rel='rdfs-seeAlso'>pg_lo_open()</a> - Open a large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_unlink" value="<div id='function.pg-lo-unlink' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-unlink.php'>pg_lo_unlink</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_unlink</span> &amp;mdash; <span class='dc-title'>Delete a large object</span></p> </div> <a name='function.pg-lo-unlink.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_lo_unlink</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$oid</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_unlink()</b> deletes a large object with the <i><tt class='parameter'>oid</tt></i> . Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_lounlink()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-unlink.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>oid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <var class='varname'>OID</var> of the large object in the database. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-unlink.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-lo-unlink.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_unlink()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;OID&amp;nbsp;of&amp;nbsp;the&amp;nbsp;large&amp;nbsp;object&amp;nbsp;to&amp;nbsp;delete<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_unlink</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-unlink.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-create.php' class='function' rel='rdfs-seeAlso'>pg_lo_create()</a> - Create a large object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-import.php' class='function' rel='rdfs-seeAlso'>pg_lo_import()</a> - Import a large object from file</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_tell" value="<div id='function.pg-lo-tell' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-tell.php'>pg_lo_tell</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_tell</span> &amp;mdash; <span class='dc-title'> Returns current seek position a of large object </span></p> </div> <a name='function.pg-lo-tell.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>pg_lo_tell</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_tell()</b> returns the current position (offset from the beginning) of a large object. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> </div> <a name='function.pg-lo-tell.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'>large_object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-tell.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The current seek offset (in number of bytes) from the beginning of the large object. If there is an error, the return value is negative. </p> </div> <a name='function.pg-lo-tell.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_tell()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$doc_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Skip&amp;nbsp;first&amp;nbsp;50000&amp;nbsp;bytes<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_SEEK_SET</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;See&amp;nbsp;how&amp;nbsp;far&amp;nbsp;we've&amp;nbsp;skipped<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$offset&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_tell</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Seek&amp;nbsp;position&amp;nbsp;is:&amp;nbsp;</span><span style='color: #0000BB'>$offset</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Seek position is: 50000 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-lo-tell.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-seek.php' class='function' rel='rdfs-seeAlso'>pg_lo_seek()</a> - Seeks position within a large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_seek" value="<div id='function.pg-lo-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-seek.php'>pg_lo_seek</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_seek</span> &amp;mdash; <span class='dc-title'> Seeks position within a large object </span></p> </div> <a name='function.pg-lo-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_lo_seek</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$whence</tt><span class='initializer'> = PGSQL_SEEK_CUR</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_lo_seek()</b> seeks a position within a large object resource. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> </div> <a name='function.pg-lo-seek.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'>large_object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</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 number of bytes to seek. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>whence</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the constants <b><tt class='constant'>PGSQL_SEEK_SET</tt></b> (seek from object start), <b><tt class='constant'>PGSQL_SEEK_CUR</tt></b> (seek from current position) or <b><tt class='constant'>PGSQL_SEEK_END</tt></b> (seek from object end) . </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-lo-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_seek()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$doc_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Skip&amp;nbsp;first&amp;nbsp;50000&amp;nbsp;bytes<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_SEEK_SET</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Read&amp;nbsp;the&amp;nbsp;next&amp;nbsp;10000&amp;nbsp;bytes<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>10000</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-seek.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-tell.php' class='function' rel='rdfs-seeAlso'>pg_lo_tell()</a> - Returns current seek position a of large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_read_all" value="<div id='function.pg-lo-read-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-read-all.php'>pg_lo_read_all</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_read_all</span> &amp;mdash; <span class='dc-title'> Reads an entire large object and send straight to browser </span></p> </div> <a name='function.pg-lo-read-all.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>pg_lo_read_all</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_read_all()</b> reads a large object and passes it straight through to the browser after sending all pending headers. Mainly intended for sending binary data like images or sound. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loreadall()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-read-all.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'>large_object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-read-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Number of bytes read or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-lo-read-all.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_read_all()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;header</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Content-type:&amp;nbsp;image/jpeg'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$image_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$image_oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_read_all</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-read-all.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-read.php' class='function' rel='rdfs-seeAlso'>pg_lo_read()</a> - Read a large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_read" value="<div id='function.pg-lo-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-read.php'>pg_lo_read</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_read</span> &amp;mdash; <span class='dc-title'>Read a large object</span></p> </div> <a name='function.pg-lo-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_lo_read</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$len</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_lo_read()</b> reads at most <i><tt class='parameter'>len</tt></i> bytes from a large object and returns it as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loread()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-read.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'>large_object</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>len</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional maximum number of bytes to return. Defaults to 8192. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing <i><tt class='parameter'>len</tt></i> bytes from the large object, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-lo-read.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_read()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$doc_oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>189762345</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$doc_oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'r'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-read.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-read-all.php' class='function' rel='rdfs-seeAlso'>pg_lo_read_all()</a> - Reads an entire large object and send straight to browser</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_open" value="<div id='function.pg-lo-open' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-open.php'>pg_lo_open</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_open</span> &amp;mdash; <span class='dc-title'>Open a large object</span></p> </div> <a name='function.pg-lo-open.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_lo_open</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$oid</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_open()</b> opens a large object in the database and returns large object resource so that it can be manipulated. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> Do not close the database connection before closing the large object resource. </p> </div> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loopen()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-open.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>oid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <var class='varname'>OID</var> of the large object in the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be either &amp;quot;r&amp;quot; for read-only, &amp;quot;w&amp;quot; for write only or &amp;quot;rw&amp;quot; for read and write. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-open.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A large object resource or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-lo-open.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_open()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$oid</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$handle</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'large&amp;nbsp;object&amp;nbsp;data'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-open.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-close.php' class='function' rel='rdfs-seeAlso'>pg_lo_close()</a> - Close a large object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-create.php' class='function' rel='rdfs-seeAlso'>pg_lo_create()</a> - Create a large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_import" value="<div id='function.pg-lo-import' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-import.php'>pg_lo_import</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_import</span> &amp;mdash; <span class='dc-title'>Import a large object from file</span></p> </div> <a name='function.pg-lo-import.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>pg_lo_import</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pathname</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$object_id</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_import()</b> creates a new large object in the database using a file on the filesystem as its data source. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>When <a href='http://www.php.net/manual/en/features.safe-mode.php' class='link'>safe mode</a> is enabled, PHP checks whether the files or directories being operated upon have the same UID (owner) as the script that is being executed.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loimport()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-import.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pathname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The full path and file name of the file on the client filesystem from which to read the large object data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If an <i><tt class='parameter'>object_id</tt></i> is given the function will try to create a large object with this id, else a free object id is assigned by the server. The parameter was added in PHP 5.3 and relies on functionality that first appeared in PostgreSQL 8.1. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-import.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The <var class='varname'>OID</var> of the newly created large object, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-lo-import.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.3.0</td> <td align='left'><p class='para'> The optional <i><tt class='parameter'>object_id</tt></i> was added. </p></td> </tr> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'><p class='para'> The syntax of this function changed. It used to be: <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>pg_lo_import</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pathname</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> </p></td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-lo-import.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_import()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_import</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'/tmp/lob.dat'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-import.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-export.php' class='function' rel='rdfs-seeAlso'>pg_lo_export()</a> - Export a large object to file</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function' rel='rdfs-seeAlso'>pg_lo_open()</a> - Open a large object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_export" value="<div id='function.pg-lo-export' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-export.php'>pg_lo_export</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_export</span> &amp;mdash; <span class='dc-title'>Export a large object to file</span></p> </div> <a name='function.pg-lo-export.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_lo_export</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$oid</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pathname</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_export()</b> takes a large object in a PostgreSQL database and saves its contents to a file on the local filesystem. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loexport()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-export.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>oid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <var class='varname'>OID</var> of the large object in the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pathname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The full path and file name of the file in which to write the large object on the client filesystem. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-export.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-lo-export.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_export()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'large&amp;nbsp;object&amp;nbsp;data'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_export</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'/tmp/lob.dat'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-export.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-import.php' class='function' rel='rdfs-seeAlso'>pg_lo_import()</a> - Import a large object from file</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_create" value="<div id='function.pg-lo-create' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-create.php'>pg_lo_create</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_create</span> &amp;mdash; <span class='dc-title'>Create a large object</span></p> </div> <a name='function.pg-lo-create.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>pg_lo_create</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$object_id</tt></span> ]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>pg_lo_create</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$object_id</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_create()</b> creates a large object and returns the <var class='varname'>OID</var> of the large object. PostgreSQL access modes <b><tt class='constant'>INV_READ</tt></b>, <b><tt class='constant'>INV_WRITE</tt></b>, and <b><tt class='constant'>INV_ARCHIVE</tt></b> are not supported, the object is created always with both read and write access. <b><tt class='constant'>INV_ARCHIVE</tt></b> has been removed from PostgreSQL itself (version 6.3 and above). </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <p class='para'> Instead of using the large object interface (which has no access controls and is cumbersome to use), try PostgreSQL&amp;#039;s <var class='varname'>bytea</var> column type and <a href='http://www.php.net/manual/en/function.pg-escape-bytea.php' class='function'>pg_escape_bytea()</a>. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_locreate()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-create.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>object_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If an <i><tt class='parameter'>object_id</tt></i> is given the function will try to create a large object with this id, else a free object id is assigned by the server. The parameter was added in PHP 5.3 and relies on functionality that first appeared in PostgreSQL 8.1. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-create.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A large object <var class='varname'>OID</var> or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-lo-create.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.3.0</td> <td align='left'><p class='para'> The optional <i><tt class='parameter'>object_id</tt></i> was added. </p></td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-lo-create.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_create()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$oid</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$handle</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'large&amp;nbsp;object&amp;nbsp;data'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_lo_close" value="<div id='function.pg-lo-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-lo-close.php'>pg_lo_close</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_lo_close</span> &amp;mdash; <span class='dc-title'>Close a large object</span></p> </div> <a name='function.pg-lo-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_lo_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$large_object</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_lo_close()</b> closes a large object. <i><tt class='parameter'>large_object</tt></i> is a resource for the large object from <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> <p class='para'> To use the large object interface, it is necessary to enclose it within a transaction block. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_loclose()</b>. <br /> </p></blockquote> </div> <a name='function.pg-lo-close.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'> PostgreSQL large object (LOB) resource, returned by <a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function'>pg_lo_open()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-lo-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-lo-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_lo_close()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=jacarta'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_create</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$oid</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$handle&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_open</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$oid</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'w'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$handle</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'large&amp;nbsp;object&amp;nbsp;data'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_lo_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$handle</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'commit'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-lo-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-open.php' class='function' rel='rdfs-seeAlso'>pg_lo_open()</a> - Open a large object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-create.php' class='function' rel='rdfs-seeAlso'>pg_lo_create()</a> - Create a large object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-lo-import.php' class='function' rel='rdfs-seeAlso'>pg_lo_import()</a> - Import a large object from file</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_last_oid" value="<div id='function.pg-last-oid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-last-oid.php'>pg_last_oid</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_last_oid</span> &amp;mdash; <span class='dc-title'>Returns the last row&amp;#039;s OID</span></p> </div> <a name='function.pg-last-oid.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_last_oid</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_last_oid()</b> is used to retrieve the <var class='varname'>OID</var> assigned to an inserted row. </p> <p class='para'> OID field became an optional field from PostgreSQL 7.2 and will not be present by default in PostgreSQL 8.1. When the OID field is not present in a table, the programmer must use <a href='http://www.php.net/manual/en/function.pg-result-status.php' class='function'>pg_result_status()</a> to check for successful insertion. </p> <p class='para'> To get the value of a <i>SERIAL</i> field in an inserted row, it is necessary to use the PostgreSQL <i>CURRVAL</i> function, naming the sequence whose last value is required. If the name of the sequence is unknown, the <i>pg_get_serial_sequence</i> PostgreSQL 8.0 function is necessary. </p> <p class='para'> PostgreSQL 8.1 has a function <i>LASTVAL</i> that returns the value of the most recently used sequence in the session. This avoids the need for naming the sequence, table or column altogether. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_getlastoid()</b>. <br /> </p></blockquote> </div> <a name='function.pg-last-oid.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-last-oid.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the OID assigned to the most recently inserted row in the specified <i><tt class='parameter'>connection</tt></i> , or <b><tt class='constant'>FALSE</tt></b> on error or no available OID. </p> </div> <a name='function.pg-last-oid.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_last_oid()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;test&amp;nbsp;(a&amp;nbsp;INTEGER)&amp;nbsp;WITH&amp;nbsp;OIDS'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;test&amp;nbsp;VALUES&amp;nbsp;(1)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$oid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_last_oid</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-last-oid.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-status.php' class='function' rel='rdfs-seeAlso'>pg_result_status()</a> - Get status of query result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_last_notice" value="<div id='function.pg-last-notice' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-last-notice.php'>pg_last_notice</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_last_notice</span> &amp;mdash; <span class='dc-title'> Returns the last notice message from PostgreSQL server </span></p> </div> <a name='function.pg-last-notice.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_last_notice</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_last_notice()</b> returns the last notice message from the PostgreSQL server on the specified <i><tt class='parameter'>connection</tt></i> . The PostgreSQL server sends notice messages in several cases, for instance when creating a <i>SERIAL</i> column in a table. </p> <p class='para'> With <b>pg_last_notice()</b>, you can avoid issuing useless queries by checking whether or not the notice is related to your transaction. </p> <p class='para'> Notice message tracking can be set to optional by setting 1 for <i>pgsql.ignore_notice</i> in <var class='filename'>php.ini</var>. </p> <p class='para'> Notice message logging can be set to optional by setting 0 for <i>pgsql.log_notice</i> in <var class='filename'>php.ini</var>. Unless <i>pgsql.ignore_notice</i> is set to 0, notice message cannot be logged. </p> </div> <a name='function.pg-last-notice.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-last-notice.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the last notice on the given <i><tt class='parameter'>connection</tt></i> , or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-last-notice.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> This function is now fully implemented. Earlier versions ignores database connection parameter. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> The <i>pgsql.ignore_notice</i> and <i>pgsql.log_notice</i> <var class='filename'>php.ini</var> directives were added. </td> </tr> <tr valign='middle'> <td align='left'>4.0.6</td> <td align='left'> PHP 4.0.6 has problem with notice message handling. Use of the PostgreSQL module with PHP 4.0.6 is not recommended even if you are not using <b>pg_last_notice()</b>. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-last-notice.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function'>pg_last_error()</a> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;test&amp;nbsp;(id&amp;nbsp;SERIAL)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$notice&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_last_notice</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$notice</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> CREATE TABLE will create implicit sequence &amp;quot;test_id_seq&amp;quot; for &amp;quot;serial&amp;quot; column &amp;quot;test.id&amp;quot; </pre></div> </div> </div><p> </p> </div> <a name='function.pg-last-notice.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-last-error.php' class='function' rel='rdfs-seeAlso'>pg_last_error()</a> - Get the last error message string of a connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_last_error" value="<div id='function.pg-last-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-last-error.php'>pg_last_error</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_last_error</span> &amp;mdash; <span class='dc-title'>Get the last error message string of a connection</span></p> </div> <a name='function.pg-last-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_last_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_last_error()</b> returns the last error message for a given <i><tt class='parameter'>connection</tt></i> . </p> <p class='para'> Error messages may be overwritten by internal PostgreSQL (libpq) function calls. It may not return an appropriate error message if multiple errors occur inside a PostgreSQL module function. </p> <p class='para'> Use <a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function'>pg_result_error()</a>, <a href='http://www.php.net/manual/en/function.pg-result-error-field.php' class='function'>pg_result_error_field()</a>, <a href='http://www.php.net/manual/en/function.pg-result-status.php' class='function'>pg_result_status()</a> and <a href='http://www.php.net/manual/en/function.pg-connection-status.php' class='function'>pg_connection_status()</a> for better error handling. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_errormessage()</b>. <br /> </p></blockquote> </div> <a name='function.pg-last-error.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-last-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the last error message on the given <i><tt class='parameter'>connection</tt></i> , or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-last-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_last_error()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Query&amp;nbsp;that&amp;nbsp;fails<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;doesnotexist'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-last-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-error.php' class='function' rel='rdfs-seeAlso'>pg_result_error()</a> - Get error message associated with result</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-result-error-field.php' class='function' rel='rdfs-seeAlso'>pg_result_error_field()</a> - Returns an individual field of an error report.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_insert" value="<div id='function.pg-insert' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-insert.php'>pg_insert</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_insert</span> &amp;mdash; <span class='dc-title'> Insert array into table </span></p> </div> <a name='function.pg-insert.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_insert</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$assoc_array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = PGSQL_DML_EXEC</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_insert()</b> inserts the values of <i><tt class='parameter'>assoc_array</tt></i> into the table specified by <i><tt class='parameter'>table_name</tt></i> . If <i><tt class='parameter'>options</tt></i> is specified, <a href='http://www.php.net/manual/en/function.pg-convert.php' class='function'>pg_convert()</a> is applied to <i><tt class='parameter'>assoc_array</tt></i> with the specified options. </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-insert.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table into which to insert rows. The table <i><tt class='parameter'>table_name</tt></i> must at least have as many columns as <i><tt class='parameter'>assoc_array</tt></i> has elements. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>assoc_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> whose keys are field names in the table <i><tt class='parameter'>table_name</tt></i> , and whose values are the values of those fields that are to be inserted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Any number of <b><tt class='constant'>PGSQL_CONV_OPTS</tt></b>, <b><tt class='constant'>PGSQL_DML_NO_CONV</tt></b>, <b><tt class='constant'>PGSQL_DML_EXEC</tt></b>, <b><tt class='constant'>PGSQL_DML_ASYNC</tt></b> or <b><tt class='constant'>PGSQL_DML_STRING</tt></b> combined. If <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is part of the <i><tt class='parameter'>options</tt></i> then query string is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-insert.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. Returns <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is passed via <i><tt class='parameter'>options</tt></i> . </p> </div> <a name='function.pg-insert.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_insert()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;safe,&amp;nbsp;since&amp;nbsp;$_POST&amp;nbsp;is&amp;nbsp;converted&amp;nbsp;automatically<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_insert</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'post_log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'POST&amp;nbsp;data&amp;nbsp;is&amp;nbsp;successfully&amp;nbsp;logged\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;must&amp;nbsp;have&amp;nbsp;sent&amp;nbsp;wrong&amp;nbsp;inputs\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-insert.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-convert.php' class='function' rel='rdfs-seeAlso'>pg_convert()</a> - Convert associative array values into suitable for SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_host" value="<div id='function.pg-host' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-host.php'>pg_host</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_host</span> &amp;mdash; <span class='dc-title'> Returns the host name associated with the connection </span></p> </div> <a name='function.pg-host.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_host</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_host()</b> returns the host name of the given PostgreSQL <i><tt class='parameter'>connection</tt></i> resource is connected to. </p> </div> <a name='function.pg-host.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-host.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the name of the host the <i><tt class='parameter'>connection</tt></i> is to, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-host.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_host()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pgsql_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mark&amp;nbsp;host=localhost'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;connected&amp;nbsp;to:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_host</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br/&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>pg_last_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$pgsql_conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;exit;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-host.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function' rel='rdfs-seeAlso'>pg_pconnect()</a> - Open a persistent PostgreSQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_get_result" value="<div id='function.pg-get-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-get-result.php'>pg_get_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_get_result</span> &amp;mdash; <span class='dc-title'> Get asynchronous query result </span></p> </div> <a name='function.pg-get-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_get_result</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_get_result()</b> gets the result resource from an asynchronous query executed by <a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a>, <a href='http://www.php.net/manual/en/function.pg-send-query-params.php' class='function'>pg_send_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-send-execute.php' class='function'>pg_send_execute()</a>. </p> <p class='para'><a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a> and the other asynchronous query functions can send multiple queries to a PostgreSQL server and <b>pg_get_result()</b> is used to get each query&amp;#039;s results, one by one. </p> </div> <a name='function.pg-get-result.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-get-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, or <b><tt class='constant'>FALSE</tt></b> if no more results are available. </p> </div> <a name='function.pg-get-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_get_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors;&amp;nbsp;select&amp;nbsp;count(*)&amp;nbsp;from&amp;nbsp;authors;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'First&amp;nbsp;call&amp;nbsp;to&amp;nbsp;pg_get_result():&amp;nbsp;</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>&amp;nbsp;has&amp;nbsp;</span><span style='color: #0000BB'>$rows1</span><span style='color: #DD0000'>&amp;nbsp;records\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Second&amp;nbsp;call&amp;nbsp;to&amp;nbsp;pg_get_result():&amp;nbsp;</span><span style='color: #0000BB'>$res2</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res2</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$res2</span><span style='color: #DD0000'>&amp;nbsp;has&amp;nbsp;</span><span style='color: #0000BB'>$rows2</span><span style='color: #DD0000'>&amp;nbsp;records\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> First call to pg_get_result(): Resource id #3 Resource id #3 has 3 records Second call to pg_get_result(): Resource id #4 Resource id #4 has 1 records </pre></div> </div> </div><p> </p> </div> <a name='function.pg-get-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function' rel='rdfs-seeAlso'>pg_send_query()</a> - Sends asynchronous query</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_get_pid" value="<div id='function.pg-get-pid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-get-pid.php'>pg_get_pid</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_get_pid</span> &amp;mdash; <span class='dc-title'>Gets the backend&amp;#039;s process ID</span></p> </div> <a name='function.pg-get-pid.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>pg_get_pid</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_get_pid()</b> gets the backend&amp;#039;s (database server process) PID. The PID is useful to determine whether or not a <i>NOTIFY</i> message received via <a href='http://www.php.net/manual/en/function.pg-get-notify.php' class='function'>pg_get_notify()</a> is sent from another process or not. </p> </div> <a name='function.pg-get-pid.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-get-pid.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The backend database process ID. </p> </div> <a name='function.pg-get-pid.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 PostgreSQL backend PID</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Backend&amp;nbsp;process&amp;nbsp;PID.&amp;nbsp;Use&amp;nbsp;PID&amp;nbsp;with&amp;nbsp;pg_get_notify()<br /></span><span style='color: #0000BB'>$pid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_pid</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-get-pid.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-get-notify.php' class='function' rel='rdfs-seeAlso'>pg_get_notify()</a> - Gets SQL NOTIFY message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_get_notify" value="<div id='function.pg-get-notify' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-get-notify.php'>pg_get_notify</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_get_notify</span> &amp;mdash; <span class='dc-title'>Gets SQL NOTIFY message</span></p> </div> <a name='function.pg-get-notify.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_get_notify</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$result_type</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_get_notify()</b> gets notifications generated by a <i>NOTIFY</i> SQL command. To receive notifications, the <i>LISTEN</i> SQL command must be issued. </p> </div> <a name='function.pg-get-notify.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional parameter that controls how the returned <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> is indexed. <i><tt class='parameter'>result_type</tt></i> is a constant and can take the following values: <b><tt class='constant'>PGSQL_ASSOC</tt></b>, <b><tt class='constant'>PGSQL_NUM</tt></b> and <b><tt class='constant'>PGSQL_BOTH</tt></b>. Using <b><tt class='constant'>PGSQL_NUM</tt></b>, <b>pg_get_notify()</b> will return an array with numerical indices, using <b><tt class='constant'>PGSQL_ASSOC</tt></b> it will return only associative indices while <b><tt class='constant'>PGSQL_BOTH</tt></b>, the default, will return both numerical and associative indices. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-get-notify.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> containing the <i>NOTIFY</i> message name and backend PID. Otherwise if no <i>NOTIFY</i> is waiting, then <b><tt class='constant'>FALSE</tt></b> is returned. </p> </div> <a name='function.pg-get-notify.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 PostgreSQL NOTIFY message</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Listen&amp;nbsp;'author_updated'&amp;nbsp;message&amp;nbsp;from&amp;nbsp;other&amp;nbsp;processes<br /></span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'LISTEN&amp;nbsp;author_updated;'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$notify&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_notify</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$notify</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;messages\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$notify</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-get-notify.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-get-pid.php' class='function' rel='rdfs-seeAlso'>pg_get_pid()</a> - Gets the backend's process ID</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_free_result" value="<div id='function.pg-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-free-result.php'>pg_free_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_free_result</span> &amp;mdash; <span class='dc-title'>Free result memory</span></p> </div> <a name='function.pg-free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_free_result()</b> frees the memory and data associated with the specified PostgreSQL query result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> <p class='para'> This function need only be called if memory consumption during script execution is a problem. Otherwise, all result memory will be automatically freed when the script ends. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_freeresult()</b>. <br /> </p></blockquote> </div> <a name='function.pg-free-result.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-free-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_free_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=users&amp;nbsp;user=me'</span><span style='color: #007700'>)&amp;nbsp;||&amp;nbsp;die();<br /><br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1&amp;nbsp;UNION&amp;nbsp;ALL&amp;nbsp;SELECT&amp;nbsp;2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'First&amp;nbsp;field&amp;nbsp;in&amp;nbsp;the&amp;nbsp;second&amp;nbsp;row&amp;nbsp;is:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>pg_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> First field in the second row is: 2 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-free-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function' rel='rdfs-seeAlso'>pg_query_params()</a> - Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-execute.php' class='function' rel='rdfs-seeAlso'>pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_type_oid" value="<div id='function.pg-field-type-oid' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-type-oid.php'>pg_field_type_oid</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_field_type_oid</span> &amp;mdash; <span class='dc-title'> Returns the type ID (OID) for the corresponding field number </span></p> </div> <a name='function.pg-field-type-oid.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>pg_field_type_oid</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'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_type_oid()</b> returns an integer containing the OID of the base type of the given <i><tt class='parameter'>field_number</tt></i> in the given PostgreSQL <i><tt class='parameter'>result</tt></i> resource. </p> <p class='para'> You can get more information about the field type by querying PostgreSQL&amp;#039;s <i>pg_type</i> system table using the OID obtained with this function. The PostgreSQL <b>format_type()</b> function will convert a type OID into an SQL standard type name. </p> <blockquote><p><b class='note'>Note</b>: If the field uses a PostgreSQL domain (rather than a basic type), it is the OID of the domain&amp;#039;s underlying type that is returned, rather than the OID of the domain itself. <br /> </p></blockquote> </div> <a name='function.pg-field-type-oid.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number, starting from 0. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-type-oid.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The OID of the field&amp;#039;s base type. <b><tt class='constant'>FALSE</tt></b> is returned on error. </p> </div> <a name='function.pg-field-type-oid.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Assume&amp;nbsp;'title'&amp;nbsp;is&amp;nbsp;a&amp;nbsp;varchar&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;title&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Title&amp;nbsp;field&amp;nbsp;type&amp;nbsp;OID:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>pg_field_type_oid</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Title field type OID: 1043 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-type-oid.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-type.php' class='function' rel='rdfs-seeAlso'>pg_field_type()</a> - Returns the type name for the corresponding field number</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-prtlen.php' class='function' rel='rdfs-seeAlso'>pg_field_prtlen()</a> - Returns the printed length</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-name.php' class='function' rel='rdfs-seeAlso'>pg_field_name()</a> - Returns the name of a field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_type" value="<div id='function.pg-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-type.php'>pg_field_type</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_type</span> &amp;mdash; <span class='dc-title'> Returns the type name for the corresponding field number </span></p> </div> <a name='function.pg-field-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_field_type</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'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_type()</b> returns a string containing the base type name of the given <i><tt class='parameter'>field_number</tt></i> in the given PostgreSQL <i><tt class='parameter'>result</tt></i> resource. </p> <blockquote><p><b class='note'>Note</b>: If the field uses a PostgreSQL domain (rather than a basic type), it is the name of the domain&amp;#039;s underlying type that is returned, rather than the name of the domain itself. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldtype()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-type.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number, starting from 0. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the base name of the field&amp;#039;s type, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-field-type.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Assume&amp;nbsp;'title'&amp;nbsp;is&amp;nbsp;a&amp;nbsp;varchar&amp;nbsp;type<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;title&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Title&amp;nbsp;field&amp;nbsp;type:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>pg_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Title field type: varchar </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-prtlen.php' class='function' rel='rdfs-seeAlso'>pg_field_prtlen()</a> - Returns the printed length</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-name.php' class='function' rel='rdfs-seeAlso'>pg_field_name()</a> - Returns the name of a field</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-type-oid.php' class='function' rel='rdfs-seeAlso'>pg_field_type_oid()</a> - Returns the type ID (OID) for the corresponding field number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_table" value="<div id='function.pg-field-table' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-table.php'>pg_field_table</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.2.0)</p><p class='refpurpose'><span class='refname'>pg_field_table</span> &amp;mdash; <span class='dc-title'>Returns the name or oid of the tables field</span></p> </div> <a name='function.pg-field-table.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_field_table</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'>$field_number</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$oid_only</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_field_table()</b> returns the name of the table that field belongs to, or the table&amp;#039;s oid if <i><tt class='parameter'>oid_only</tt></i> is <b><tt class='constant'>TRUE</tt></b>. </p> </div> <a name='function.pg-field-table.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number, starting from 0. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>oid_only</tt></i> </span> </dt><dd class='listitem'> <p class='para'> By default the tables name that field belongs to is returned but if <i><tt class='parameter'>oid_only</tt></i> is set to <b><tt class='constant'>TRUE</tt></b>, then the oid will instead be returned. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-table.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> On success either the fields table name or oid. Or, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-field-table.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting table information about a field</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;bar&amp;nbsp;FROM&amp;nbsp;foo'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>pg_field_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>pg_field_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;version()'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>pg_field_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</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> foo 14379580 bool(false) </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-table.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Returning the oid is much faster than returning the table name because fetching the table name requires a query to the database system table. <br /> </p></blockquote> </div> <a name='function.pg-field-table.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-name.php' class='function' rel='rdfs-seeAlso'>pg_field_name()</a> - Returns the name of a field</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-type.php' class='function' rel='rdfs-seeAlso'>pg_field_type()</a> - Returns the type name for the corresponding field number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_size" value="<div id='function.pg-field-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-size.php'>pg_field_size</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_size</span> &amp;mdash; <span class='dc-title'> Returns the internal storage size of the named field </span></p> </div> <a name='function.pg-field-size.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>pg_field_size</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'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_size()</b> returns the internal storage size (in bytes) of the field number in the given PostgreSQL <i><tt class='parameter'>result</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldsize()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-size.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number, starting from 0. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The internal field storage size (in bytes). -1 indicates a variable length field. <b><tt class='constant'>FALSE</tt></b> is returned on error. </p> </div> <a name='function.pg-field-size.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;for&amp;nbsp;(</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'column&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$fieldname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'fieldname:&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'printed&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_prtlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;characters\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'storage&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;bytes\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'field&amp;nbsp;type:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> column 0 fieldname: author printed length: 6 characters storage length: -1 bytes field type: varchar column 1 fieldname: year printed length: 4 characters storage length: 2 bytes field type: int2 column 2 fieldname: title printed length: 24 characters storage length: -1 bytes field type: varchar </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-size.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-prtlen.php' class='function' rel='rdfs-seeAlso'>pg_field_prtlen()</a> - Returns the printed length</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-type.php' class='function' rel='rdfs-seeAlso'>pg_field_type()</a> - Returns the type name for the corresponding field number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_prtlen" value="<div id='function.pg-field-prtlen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-prtlen.php'>pg_field_prtlen</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_prtlen</span> &amp;mdash; <span class='dc-title'>Returns the printed length</span></p> </div> <a name='function.pg-field-prtlen.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>pg_field_prtlen</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'>$row_number</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field_name_or_number</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>pg_field_prtlen</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field_name_or_number</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_prtlen()</b> returns the actual printed length (number of characters) of a specific value in a PostgreSQL <i><tt class='parameter'>result</tt></i> . Row numbering starts at 0. This function will return -1 on an error. </p> <p class='para'> <i><tt class='parameter'>field_name_or_number</tt></i> can be passed either as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> or as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. If it is passed as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a>, PHP recognises it as the field number, otherwise as field name. </p> <p class='para'> See the example given at the <a href='http://www.php.net/manual/en/function.pg-field-name.php' class='function'>pg_field_name()</a> page. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldprtlen()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-prtlen.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result. Rows are numbered from 0 upwards. If omitted, current row is fetched. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-prtlen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The field printed length, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-field-prtlen.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;for&amp;nbsp;(</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'column&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$fieldname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'fieldname:&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'printed&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_prtlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;characters\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'storage&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;bytes\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'field&amp;nbsp;type:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> column 0 fieldname: author printed length: 6 characters storage length: -1 bytes field type: varchar column 1 fieldname: year printed length: 4 characters storage length: 2 bytes field type: int2 column 2 fieldname: title printed length: 24 characters storage length: -1 bytes field type: varchar </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-prtlen.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-size.php' class='function' rel='rdfs-seeAlso'>pg_field_size()</a> - Returns the internal storage size of the named field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_num" value="<div id='function.pg-field-num' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-num.php'>pg_field_num</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_num</span> &amp;mdash; <span class='dc-title'>Returns the field number of the named field</span></p> </div> <a name='function.pg-field-num.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>pg_field_num</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$field_name</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_num()</b> will return the number of the field number that corresponds to the <i><tt class='parameter'>field_name</tt></i> in the given PostgreSQL <i><tt class='parameter'>result</tt></i> resource. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldnum()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-num.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the field. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-num.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The field number (numbered from 0), or -1 on error. </p> </div> <a name='function.pg-field-num.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;author,&amp;nbsp;year,&amp;nbsp;title&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Column&amp;nbsp;'title'&amp;nbsp;is&amp;nbsp;field&amp;nbsp;number:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>pg_field_num</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'title'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Column &amp;#039;title&amp;#039; is field number: 2 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-num.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-name.php' class='function' rel='rdfs-seeAlso'>pg_field_name()</a> - Returns the name of a field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_name" value="<div id='function.pg-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-name.php'>pg_field_name</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_name</span> &amp;mdash; <span class='dc-title'>Returns the name of a field</span></p> </div> <a name='function.pg-field-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_field_name</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'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_name()</b> returns the name of the field occupying the given <i><tt class='parameter'>field_number</tt></i> in the given PostgreSQL <i><tt class='parameter'>result</tt></i> resource. Field numbering starts from 0. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldname()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-name.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number, starting from 0. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The field name, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-field-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Getting information about fields</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;for&amp;nbsp;(</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'column&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$fieldname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'fieldname:&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'printed&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_prtlen</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$fieldname</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;characters\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'storage&amp;nbsp;length:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;bytes\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'field&amp;nbsp;type:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>pg_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$j</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> column 0 fieldname: author printed length: 6 characters storage length: -1 bytes field type: varchar column 1 fieldname: year printed length: 4 characters storage length: 2 bytes field type: int2 column 2 fieldname: title printed length: 24 characters storage length: -1 bytes field type: varchar </pre></div> </div> </div><p> </p> </div> <a name='function.pg-field-name.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-field-num.php' class='function' rel='rdfs-seeAlso'>pg_field_num()</a> - Returns the field number of the named field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_field_is_null" value="<div id='function.pg-field-is-null' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-field-is-null.php'>pg_field_is_null</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_field_is_null</span> &amp;mdash; <span class='dc-title'>Test if a field is SQL <i>NULL</i></span></p> </div> <a name='function.pg-field-is-null.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>pg_field_is_null</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'>$row</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>pg_field_is_null</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_field_is_null()</b> tests if a field in a PostgreSQL result resource is SQL <i>NULL</i> or not. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_fieldisnull()</b>. <br /> </p></blockquote> </div> <a name='function.pg-field-is-null.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, current row is fetched. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Field number (starting from 0) as an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type integer'>integer</a> or the field name as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-field-is-null.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <i>1</i> if the field in the given row is SQL <i>NULL</i>, <i>0</i> if not. <b><tt class='constant'>FALSE</tt></b> is returned if the row is out of range, or upon any other error. </p> </div> <a name='function.pg-field-is-null.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_field_is_null()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die&amp;nbsp;(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors&amp;nbsp;where&amp;nbsp;author&amp;nbsp;=&amp;nbsp;'Orwell''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>pg_field_is_null</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'year'</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;value&amp;nbsp;of&amp;nbsp;the&amp;nbsp;field&amp;nbsp;year&amp;nbsp;is&amp;nbsp;null.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>pg_field_is_null</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'year'</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;value&amp;nbsp;of&amp;nbsp;the&amp;nbsp;field&amp;nbsp;year&amp;nbsp;is&amp;nbsp;not&amp;nbsp;null.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_row" value="<div id='function.pg-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-row.php'>pg_fetch_row</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_row</span> &amp;mdash; <span class='dc-title'>Get a row as an enumerated array</span></p> </div> <a name='function.pg-fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_fetch_row</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'>$row</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_fetch_row()</b> fetches one row of data from the result associated with the specified <i><tt class='parameter'>result</tt></i> resource. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.pg-fetch-row.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, next row is fetched. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>, indexed from 0 upwards, with each value represented as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. Database <i>NULL</i> values are returned as <b><tt class='constant'>NULL</tt></b>. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>row</tt></i> exceeds the number of rows in the set, there are no more rows, or on any other error. </p> </div> <a name='function.pg-fetch-row.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The parameter <i><tt class='parameter'>row</tt></i> became optional. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-fetch-row.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_row()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Author:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;E-mail:&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br />&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-row.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_result" value="<div id='function.pg-fetch-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-result.php'>pg_fetch_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_result</span> &amp;mdash; <span class='dc-title'>Returns values from a result resource</span></p> </div> <a name='function.pg-fetch-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_fetch_result</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'>$row</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_fetch_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_fetch_result()</b> returns the value of a particular row and field (column) in a PostgreSQL result resource. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_result()</b>. <br /> </p></blockquote> </div> <a name='function.pg-fetch-result.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, next row is fetched. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> representing the name of the field (column) to fetch, otherwise an <a href='http://www.php.net/manual/en/language.types.integer.php' class='type int'>int</a> representing the field number to fetch. Fields are numbered from 0 upwards. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Boolean is returned as &amp;quot;t&amp;quot; or &amp;quot;f&amp;quot;. All other types, including arrays are returned as strings formatted in the same default PostgreSQL manner that you would see in the <strong class='command'>psql</strong> program. Database <i>NULL</i> values are returned as <b><tt class='constant'>NULL</tt></b>. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>row</tt></i> exceeds the number of rows in the set, or on any other error. </p> </div> <a name='function.pg-fetch-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=users&amp;nbsp;user=me'</span><span style='color: #007700'>)&amp;nbsp;||&amp;nbsp;die();<br /><br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;1&amp;nbsp;UNION&amp;nbsp;ALL&amp;nbsp;SELECT&amp;nbsp;2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'First&amp;nbsp;field&amp;nbsp;in&amp;nbsp;the&amp;nbsp;second&amp;nbsp;row&amp;nbsp;is:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> First field in the second row is: 2 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_object" value="<div id='function.pg-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-object.php'>pg_fetch_object</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_object</span> &amp;mdash; <span class='dc-title'>Fetch a row as an object</span></p> </div> <a name='function.pg-fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>pg_fetch_object</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'>$row</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$result_type</tt></span> ]] )</div> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>pg_fetch_object</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'>$row</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$class_name</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> ]]] )</div> <p class='para rdfs-comment'> <b>pg_fetch_object()</b> returns an object with properties that correspond to the fetched row&amp;#039;s field names. It can optionally instantiate an object of a specific class, and pass parameters to that class&amp;#039;s constructor. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <p class='para'> Speed-wise, the function is identical to <a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function'>pg_fetch_array()</a>, and almost as fast as <a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function'>pg_fetch_row()</a> (the difference is insignificant). </p> </div> <a name='function.pg-fetch-object.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, next row is fetched. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Ignored and deprecated. Defaults to <b><tt class='constant'>PGSQL_ASSOC</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>class_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the class to instantiate, set the properties of and return. If not specified, a <b class='classname'>stdClass</b> object is returned. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of parameters to pass to the constructor for <i><tt class='parameter'>class_name</tt></i> objects. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a> with one attribute for each field name in the result. Database <i>NULL</i> values are returned as <b><tt class='constant'>NULL</tt></b>. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>row</tt></i> exceeds the number of rows in the set, there are no more rows, or on any other error. </p> </div> <a name='function.pg-fetch-object.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.0.0</td> <td align='left'> <i><tt class='parameter'>class_name</tt></i> and <i><tt class='parameter'>params</tt></i> were added. The old form with <i><tt class='parameter'>result_type</tt></i> still exists for backwards compatibility. </td> </tr> <tr valign='middle'> <td align='left'>4.3.0</td> <td align='left'> <i><tt class='parameter'>result_type</tt></i> default changed from <b><tt class='constant'>PGSQL_BOTH</tt></b> to <b><tt class='constant'>PGSQL_ASSOC</tt></b>, since the numeric index was illegal. </td> </tr> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The parameter <i><tt class='parameter'>row</tt></i> became optional. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-fetch-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_object()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br /><br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'store'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$db_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$db_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Failed&amp;nbsp;connecting&amp;nbsp;to&amp;nbsp;postgres&amp;nbsp;database&amp;nbsp;</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$qu&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;books&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;author'</span><span style='color: #007700'>);<br /><br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$qu</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>author&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;('</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>year&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'):&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>title&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>pg_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$qu</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>pg_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db_conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-object.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>pg_fetch_assoc()</a> - Fetch a row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function' rel='rdfs-seeAlso'>pg_fetch_row()</a> - Get a row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_assoc" value="<div id='function.pg-fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-assoc.php'>pg_fetch_assoc</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_assoc</span> &amp;mdash; <span class='dc-title'>Fetch a row as an associative array</span></p> </div> <a name='function.pg-fetch-assoc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_fetch_assoc</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'>$row</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_fetch_assoc()</b> returns an associative array that corresponds to the fetched row (records). </p> <p class='para'> <b>pg_fetch_assoc()</b> is equivalent to calling <a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function'>pg_fetch_array()</a> with <b><tt class='constant'>PGSQL_ASSOC</tt></b> as the optional third parameter. It only returns an associative array. If you need the numeric indices, use <a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function'>pg_fetch_row()</a>. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <p class='para'> <b>pg_fetch_assoc()</b> is NOT significantly slower than using <a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function'>pg_fetch_row()</a>, and is significantly easier to use. </p> </div> <a name='function.pg-fetch-assoc.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, next row is fetched. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> indexed associatively (by field name). Each value in the <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> is represented as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. Database <i>NULL</i> values are returned as <b><tt class='constant'>NULL</tt></b>. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>row</tt></i> exceeds the number of rows in the set, there are no more rows, or on any other error. </p> </div> <a name='function.pg-fetch-assoc.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The parameter <i><tt class='parameter'>row</tt></i> became optional. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-fetch-assoc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_assoc()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'id'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'author'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'email'</span><span style='color: #007700'>];<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-assoc.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function' rel='rdfs-seeAlso'>pg_fetch_row()</a> - Get a row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_array" value="<div id='function.pg-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-array.php'>pg_fetch_array</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_array</span> &amp;mdash; <span class='dc-title'>Fetch a row as an array</span></p> </div> <a name='function.pg-fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_fetch_array</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'>$row</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$result_type</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>pg_fetch_array()</b> returns an array that corresponds to the fetched row (record). </p> <p class='para'> <b>pg_fetch_array()</b> is an extended version of <a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function'>pg_fetch_row()</a>. In addition to storing the data in the numeric indices (field number) to the result array, it can also store the data using associative indices (field name). It stores both indicies by default. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <p class='para'> <b>pg_fetch_array()</b> is NOT significantly slower than using <a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function'>pg_fetch_row()</a>, and is significantly easier to use. </p> </div> <a name='function.pg-fetch-array.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Row number in result to fetch. Rows are numbered from 0 upwards. If omitted, next row is fetched. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional parameter that controls how the returned <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> is indexed. <i><tt class='parameter'>result_type</tt></i> is a constant and can take the following values: <b><tt class='constant'>PGSQL_ASSOC</tt></b>, <b><tt class='constant'>PGSQL_NUM</tt></b> and <b><tt class='constant'>PGSQL_BOTH</tt></b>. Using <b><tt class='constant'>PGSQL_NUM</tt></b>, <b>pg_fetch_array()</b> will return an array with numerical indices, using <b><tt class='constant'>PGSQL_ASSOC</tt></b> it will return only associative indices while <b><tt class='constant'>PGSQL_BOTH</tt></b>, the default, will return both numerical and associative indices. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> indexed numerically (beginning with 0) or associatively (indexed by field name), or both. Each value in the <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> is represented as a <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a>. Database <i>NULL</i> values are returned as <b><tt class='constant'>NULL</tt></b>. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>row</tt></i> exceeds the number of rows in the set, there are no more rows, or on any other error. </p> </div> <a name='function.pg-fetch-array.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.1.0</td> <td align='left'> The <i><tt class='parameter'>row</tt></i> parameter became optional. </td> </tr> <tr valign='middle'> <td align='left'>4.0.0</td> <td align='left'> The <i><tt class='parameter'>result_type</tt></i> parameter was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_array()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;author,&amp;nbsp;email&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_NUM</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;1&amp;nbsp;Author\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;1&amp;nbsp;E-mail\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;As&amp;nbsp;of&amp;nbsp;PHP&amp;nbsp;4.1.0,&amp;nbsp;the&amp;nbsp;row&amp;nbsp;parameter&amp;nbsp;is&amp;nbsp;optional;&amp;nbsp;NULL&amp;nbsp;can&amp;nbsp;be&amp;nbsp;passed&amp;nbsp;instead,<br />//&amp;nbsp;to&amp;nbsp;pass&amp;nbsp;a&amp;nbsp;result_type.&amp;nbsp;&amp;nbsp;Successive&amp;nbsp;calls&amp;nbsp;to&amp;nbsp;pg_fetch_array&amp;nbsp;will&amp;nbsp;return&amp;nbsp;the<br />//&amp;nbsp;next&amp;nbsp;row.<br /></span><span style='color: #0000BB'>$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>NULL</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_ASSOC</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'author'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;2&amp;nbsp;Author\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'email'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;2&amp;nbsp;E-mail\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'author'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;3&amp;nbsp;Author\n'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;-&amp;nbsp;Row&amp;nbsp;3&amp;nbsp;E-mail\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-array.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function' rel='rdfs-seeAlso'>pg_fetch_row()</a> - Get a row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_all_columns" value="<div id='function.pg-fetch-all-columns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-all-columns.php'>pg_fetch_all_columns</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_fetch_all_columns</span> &amp;mdash; <span class='dc-title'>Fetches all rows in a particular result column as an array</span></p> </div> <a name='function.pg-fetch-all-columns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_fetch_all_columns</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'>$column</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_fetch_all_columns()</b> returns an array that contains all rows (records) in a particular column of the result resource. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.pg-fetch-all-columns.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Column number, zero-based, to be retrieved from the result resource. Defaults to the first column if not specified. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-all-columns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> with all values in the result column. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if <i><tt class='parameter'>column</tt></i> is larger than the number of columns in the result, or on any other error. </p> </div> <a name='function.pg-fetch-all-columns.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_fetch_all_columns()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;title,&amp;nbsp;name,&amp;nbsp;address&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Get&amp;nbsp;an&amp;nbsp;array&amp;nbsp;of&amp;nbsp;all&amp;nbsp;author&amp;nbsp;names<br /></span><span style='color: #0000BB'>$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_all_columns</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-all-columns.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-all.php' class='function' rel='rdfs-seeAlso'>pg_fetch_all()</a> - Fetches all rows from a result as an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_fetch_all" value="<div id='function.pg-fetch-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-fetch-all.php'>pg_fetch_all</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_fetch_all</span> &amp;mdash; <span class='dc-title'>Fetches all rows from a result as an array</span></p> </div> <a name='function.pg-fetch-all.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_fetch_all</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_fetch_all()</b> returns an array that contains all rows (records) in the result resource. </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.pg-fetch-all.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-fetch-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> with all rows in the result. Each row is an array of field values indexed by field name. </p> <p class='para'> <b><tt class='constant'>FALSE</tt></b> is returned if there are no rows in the result, or on any other error. </p> </div> <a name='function.pg-fetch-all.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 PostgreSQL fetch all</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;authors'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'An&amp;nbsp;error&amp;nbsp;occured.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;exit;<br />}<br /><br /></span><span style='color: #0000BB'>$arr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_fetch_all</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$arr</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-fetch-all.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-row.php' class='function' rel='rdfs-seeAlso'>pg_fetch_row()</a> - Get a row as an enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-array.php' class='function' rel='rdfs-seeAlso'>pg_fetch_array()</a> - Fetch a row as an array</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-object.php' class='function' rel='rdfs-seeAlso'>pg_fetch_object()</a> - Fetch a row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-fetch-result.php' class='function' rel='rdfs-seeAlso'>pg_fetch_result()</a> - Returns values from a result resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_execute" value="<div id='function.pg-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-execute.php'>pg_execute</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.0)</p><p class='refpurpose'><span class='refname'>pg_execute</span> &amp;mdash; <span class='dc-title'>Sends a request to execute a prepared statement with given parameters, and waits for the result.</span></p> </div> <a name='function.pg-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_execute</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$stmtname</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$params</tt></span> )</div> <p class='para rdfs-comment'> Sends a request to execute a prepared statement with given parameters, and waits for the result. </p> <p class='para'> <b>pg_execute()</b> is like <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a>, but the command to be executed is specified by naming a previously-prepared statement, instead of giving a query string. This feature allows commands that will be used repeatedly to be parsed and planned just once, rather than each time they are executed. The statement must have been prepared previously in the current session. <b>pg_execute()</b> is supported only against PostgreSQL 7.4 or higher connections; it will fail when using earlier versions. </p> <p class='para'> The parameters are identical to <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a>, except that the name of a prepared statement is given instead of a query string. </p> </div> <a name='function.pg-execute.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>stmtname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the prepared statement to execute. if &amp;quot;&amp;quot; is specified, then the unnamed statement is executed. The name must have been previously prepared using <a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function'>pg_prepare()</a>, <a href='http://www.php.net/manual/en/function.pg-send-prepare.php' class='function'>pg_send_prepare()</a> or a <i>PREPARE</i> SQL command. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>params</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of parameter values to substitute for the $1, $2, etc. placeholders in the original prepared query string. The number of elements in the array must match the number of placeholders. </p> <div class='warning'><b class='warning'>Warning</b> <p class='para'> Elements are converted to strings by calling this function. </p> </div> </dd> </dl> <p> </p> </div> <a name='function.pg-execute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A query result resource on success, or <b><tt class='constant'>FALSE</tt></b> on failure.</p> </div> <a name='function.pg-execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_execute()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'<br /></span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mary'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Prepare&amp;nbsp;a&amp;nbsp;query&amp;nbsp;for&amp;nbsp;execution<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;shops&amp;nbsp;WHERE&amp;nbsp;name&amp;nbsp;=&amp;nbsp;$1'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;prepared&amp;nbsp;query.&amp;nbsp;&amp;nbsp;Note&amp;nbsp;that&amp;nbsp;it&amp;nbsp;is&amp;nbsp;not&amp;nbsp;necessary&amp;nbsp;to&amp;nbsp;escape<br />//&amp;nbsp;the&amp;nbsp;string&amp;nbsp;'Joe's&amp;nbsp;Widgets'&amp;nbsp;in&amp;nbsp;any&amp;nbsp;way<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Joe's&amp;nbsp;Widgets'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;same&amp;nbsp;prepared&amp;nbsp;query,&amp;nbsp;this&amp;nbsp;time&amp;nbsp;with&amp;nbsp;a&amp;nbsp;different&amp;nbsp;parameter<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'my_query'</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'Clothes&amp;nbsp;Clothes&amp;nbsp;Clothes'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-prepare.php' class='function' rel='rdfs-seeAlso'>pg_prepare()</a> - Submits a request to create a prepared statement with the given parameters, and waits for completion.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-prepare.php' class='function' rel='rdfs-seeAlso'>pg_send_prepare()</a> - Sends a request to create a prepared statement with the given parameters, without waiting for completion.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function' rel='rdfs-seeAlso'>pg_query_params()</a> - Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_escape_string" value="<div id='function.pg-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-escape-string.php'>pg_escape_string</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_escape_string</span> &amp;mdash; <span class='dc-title'> Escape a string for insertion into a text field </span></p> </div> <a name='function.pg-escape-string.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_escape_string</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_escape_string()</b> escapes a string for insertion into the database. It returns an escaped string in the PostgreSQL format. Use of this function is recommended instead of <a href='http://www.php.net/manual/en/function.addslashes.php' class='function'>addslashes()</a>. If the type of the column is bytea, <a href='http://www.php.net/manual/en/function.pg-escape-bytea.php' class='function'>pg_escape_bytea()</a> must be used instead. </p> <blockquote><p><b class='note'>Note</b>: This function requires PostgreSQL 7.2 or later. <br /> </p></blockquote> </div> <a name='function.pg-escape-string.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing text to be escaped. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-escape-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the escaped data. </p> </div> <a name='function.pg-escape-string.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'><i><tt class='parameter'>connection</tt></i> added</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-escape-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_escape_string()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Read&amp;nbsp;in&amp;nbsp;a&amp;nbsp;text&amp;nbsp;file&amp;nbsp;(containing&amp;nbsp;apostrophes&amp;nbsp;and&amp;nbsp;backslashes)<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>file_get_contents</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'letter.txt'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Escape&amp;nbsp;the&amp;nbsp;text&amp;nbsp;data<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$escaped&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Insert&amp;nbsp;it&amp;nbsp;into&amp;nbsp;the&amp;nbsp;database<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;correspondence&amp;nbsp;(name,&amp;nbsp;data)&amp;nbsp;VALUES&amp;nbsp;('My&amp;nbsp;letter',&amp;nbsp;'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$escaped</span><span style='color: #007700'>}</span><span style='color: #DD0000'>')'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-escape-string.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-escape-bytea.php' class='function' rel='rdfs-seeAlso'>pg_escape_bytea()</a> - Escape a string for insertion into a bytea field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_escape_bytea" value="<div id='function.pg-escape-bytea' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-escape-bytea.php'>pg_escape_bytea</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_escape_bytea</span> &amp;mdash; <span class='dc-title'> Escape a string for insertion into a bytea field </span></p> </div> <a name='function.pg-escape-bytea.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_escape_bytea</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ], <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_escape_bytea()</b> escapes string for bytea datatype. It returns escaped string. </p> <blockquote><p><b class='note'>Note</b>: When you <i>SELECT</i> a bytea type, PostgreSQL returns octal byte values prefixed with &amp;#039;\&amp;#039; (e.g. \032). Users are supposed to convert back to binary format manually. <br /> This function requires PostgreSQL 7.2 or later. With PostgreSQL 7.2.0 and 7.2.1, bytea values must be cast when you enable multi-byte support. i.e. <i>INSERT INTO test_table (image) VALUES (&amp;#039;$image_escaped&amp;#039;::bytea);</i> PostgreSQL 7.2.2 or later does not need a cast. The exception is when the client and backend character encoding does not match, and there may be multi-byte stream error. User must then cast to bytea to avoid this error. <br /> </p></blockquote> </div> <a name='function.pg-escape-bytea.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing text or binary data to be inserted into a bytea column. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-escape-bytea.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the escaped data. </p> </div> <a name='function.pg-escape-bytea.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.0</td> <td align='left'><i><tt class='parameter'>connection</tt></i> added</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.pg-escape-bytea.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_escape_bytea()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Read&amp;nbsp;in&amp;nbsp;a&amp;nbsp;binary&amp;nbsp;file<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>file_get_contents</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'image1.jpg'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Escape&amp;nbsp;the&amp;nbsp;binary&amp;nbsp;data<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$escaped&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_escape_bytea</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Insert&amp;nbsp;it&amp;nbsp;into&amp;nbsp;the&amp;nbsp;database<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;gallery&amp;nbsp;(name,&amp;nbsp;data)&amp;nbsp;VALUES&amp;nbsp;('Pine&amp;nbsp;trees',&amp;nbsp;'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$escaped</span><span style='color: #007700'>}</span><span style='color: #DD0000'>')'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-escape-bytea.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-unescape-bytea.php' class='function' rel='rdfs-seeAlso'>pg_unescape_bytea()</a> - Unescape binary for bytea type</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-escape-string.php' class='function' rel='rdfs-seeAlso'>pg_escape_string()</a> - Escape a string for insertion into a text field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_end_copy" value="<div id='function.pg-end-copy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-end-copy.php'>pg_end_copy</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_end_copy</span> &amp;mdash; <span class='dc-title'>Sync with PostgreSQL backend</span></p> </div> <a name='function.pg-end-copy.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_end_copy</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_end_copy()</b> syncs the PostgreSQL frontend (usually a web server process) with the PostgreSQL server after doing a copy operation performed by <a href='http://www.php.net/manual/en/function.pg-put-line.php' class='function'>pg_put_line()</a>. <b>pg_end_copy()</b> must be issued, otherwise the PostgreSQL server may get out of sync with the frontend and will report an error. </p> </div> <a name='function.pg-end-copy.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-end-copy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-end-copy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_end_copy()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'create&amp;nbsp;table&amp;nbsp;bar&amp;nbsp;(a&amp;nbsp;int4,&amp;nbsp;b&amp;nbsp;char(16),&amp;nbsp;d&amp;nbsp;float8)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'copy&amp;nbsp;bar&amp;nbsp;from&amp;nbsp;stdin'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'3\thello&amp;nbsp;world\t4.5\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'4\tgoodbye&amp;nbsp;world\t7.11\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_put_line</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\\.\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_end_copy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-end-copy.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-put-line.php' class='function' rel='rdfs-seeAlso'>pg_put_line()</a> - Send a NULL-terminated string to PostgreSQL backend</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_delete" value="<div id='function.pg-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-delete.php'>pg_delete</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_delete</span> &amp;mdash; <span class='dc-title'> Deletes records </span></p> </div> <a name='function.pg-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>pg_delete</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$assoc_array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = PGSQL_DML_EXEC</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_delete()</b> deletes records from a table specified by the keys and values in <i><tt class='parameter'>assoc_array</tt></i> . If <i><tt class='parameter'>options</tt></i> is specified, <a href='http://www.php.net/manual/en/function.pg-convert.php' class='function'>pg_convert()</a> is applied to <i><tt class='parameter'>assoc_array</tt></i> with the specified options. </p> </div> <a name='function.pg-delete.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table from which to delete rows. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>assoc_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> whose keys are field names in the table <i><tt class='parameter'>table_name</tt></i> , and whose values are the values of those fields that are to be deleted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Any number of <b><tt class='constant'>PGSQL_CONV_FORCE_NULL</tt></b>, <b><tt class='constant'>PGSQL_DML_NO_CONV</tt></b>, <b><tt class='constant'>PGSQL_DML_EXEC</tt></b> or <b><tt class='constant'>PGSQL_DML_STRING</tt></b> combined. If <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is part of the <i><tt class='parameter'>options</tt></i> then query string is returned. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. Returns <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> if <b><tt class='constant'>PGSQL_DML_STRING</tt></b> is passed via <i><tt class='parameter'>options</tt></i> . </p> </div> <a name='function.pg-delete.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_delete()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;is&amp;nbsp;safe,&amp;nbsp;since&amp;nbsp;$_POST&amp;nbsp;is&amp;nbsp;converted&amp;nbsp;automatically<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_delete</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'post_log'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$_POST</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'POST&amp;nbsp;data&amp;nbsp;is&amp;nbsp;deleted:&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;must&amp;nbsp;have&amp;nbsp;sent&amp;nbsp;wrong&amp;nbsp;inputs\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-delete.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-convert.php' class='function' rel='rdfs-seeAlso'>pg_convert()</a> - Convert associative array values into suitable for SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_dbname" value="<div id='function.pg-dbname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-dbname.php'>pg_dbname</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_dbname</span> &amp;mdash; <span class='dc-title'>Get the database name</span></p> </div> <a name='function.pg-dbname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_dbname</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_dbname()</b> returns the name of the database that the given PostgreSQL <i><tt class='parameter'>connection</tt></i> resource. </p> </div> <a name='function.pg-dbname.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-dbname.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> A <a href='http://www.php.net/manual/en/language.types.string.php' class='type string'>string</a> containing the name of the database the <i><tt class='parameter'>connection</tt></i> is to, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-dbname.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_dbname()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;error_reporting</span><span style='color: #007700'>(</span><span style='color: #0000BB'>E_ALL</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=mary'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>pg_dbname</span><span style='color: #007700'>();&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;mary<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_copy_to" value="<div id='function.pg-copy-to' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-copy-to.php'>pg_copy_to</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_copy_to</span> &amp;mdash; <span class='dc-title'> Copy a table to an array </span></p> </div> <a name='function.pg-copy-to.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_copy_to</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$delimiter</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$null_as</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>pg_copy_to()</b> copies a table to an array. It issues <i>COPY TO</i> SQL command internally to retrieve records. </p> </div> <a name='function.pg-copy-to.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table from which to copy the data into <i><tt class='parameter'>rows</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>delimiter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The token that separates values for each field in each element of <i><tt class='parameter'>rows</tt></i> . Default is <i>TAB</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>null_as</tt></i> </span> </dt><dd class='listitem'> <p class='para'> How SQL <i>NULL</i> values are represented in the <i><tt class='parameter'>rows</tt></i> . Default is \N (&amp;quot;\\N&amp;quot;). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-copy-to.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> with one element for each line of <i>COPY</i> data. It returns <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-copy-to.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_copy_to()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_copy_to</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_copy_from</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rows</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-copy-to.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-copy-from.php' class='function' rel='rdfs-seeAlso'>pg_copy_from()</a> - Insert records into a table from an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_copy_from" value="<div id='function.pg-copy-from' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-copy-from.php'>pg_copy_from</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_copy_from</span> &amp;mdash; <span class='dc-title'> Insert records into a table from an array </span></p> </div> <a name='function.pg-copy-from.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_copy_from</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$rows</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$delimiter</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$null_as</tt></span> ]] )</div> <p class='para rdfs-comment'> <b>pg_copy_from()</b> inserts records into a table from <i><tt class='parameter'>rows</tt></i> . It issues a <i>COPY FROM</i> SQL command internally to insert records. </p> </div> <a name='function.pg-copy-from.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table into which to copy the <i><tt class='parameter'>rows</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rows</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of data to be copied into <i><tt class='parameter'>table_name</tt></i> . Each value in <i><tt class='parameter'>rows</tt></i> becomes a row in <i><tt class='parameter'>table_name</tt></i> . Each value in <i><tt class='parameter'>rows</tt></i> should be a delimited string of the values to insert into each field. Values should be linefeed terminated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>delimiter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The token that separates values for each field in each element of <i><tt class='parameter'>rows</tt></i> . Default is <i>TAB</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>null_as</tt></i> </span> </dt><dd class='listitem'> <p class='para'> How SQL <i>NULL</i> values are represented in the <i><tt class='parameter'>rows</tt></i> . Default is \N (&amp;quot;\\N&amp;quot;). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-copy-from.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-copy-from.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_copy_from()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_copy_to</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_copy_from</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$table_name</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rows</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-copy-from.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-copy-to.php' class='function' rel='rdfs-seeAlso'>pg_copy_to()</a> - Copy a table to an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_convert" value="<div id='function.pg-convert' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-convert.php'>pg_convert</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_convert</span> &amp;mdash; <span class='dc-title'> Convert associative array values into suitable for SQL statement </span></p> </div> <a name='function.pg-convert.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>pg_convert</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$assoc_array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$options</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> <b>pg_convert()</b> checks and converts the values in <i><tt class='parameter'>assoc_array</tt></i> into suitable values for use in a SQL statement. Precondition for <b>pg_convert()</b> is the existence of a table <i><tt class='parameter'>table_name</tt></i> which has at least as many columns as <i><tt class='parameter'>assoc_array</tt></i> has elements. The fieldnames in <i><tt class='parameter'>table_name</tt></i> must match the indices in <i><tt class='parameter'>assoc_array</tt></i> and the corresponding datatypes must be compatible. Returns an array with the converted values on success, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> <blockquote><p><b class='note'>Note</b>: If there are boolean fields in <i><tt class='parameter'>table_name</tt></i> don&amp;#039;t use the constant <b><tt class='constant'>TRUE</tt></b> in <i><tt class='parameter'>assoc_array</tt></i> . It will be converted to the string &amp;#039;TRUE&amp;#039; which is no valid entry for boolean fields in PostgreSQL. Use one of t, true, 1, y, yes instead. <br /> </p></blockquote> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is <em class='emphasis'>EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> </div> <a name='function.pg-convert.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Name of the table against which to convert types. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>assoc_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Data to be converted. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Any number of <b><tt class='constant'>PGSQL_CONV_IGNORE_DEFAULT</tt></b>, <b><tt class='constant'>PGSQL_CONV_FORCE_NULL</tt></b> or <b><tt class='constant'>PGSQL_CONV_IGNORE_NOT_NULL</tt></b>, combined. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-convert.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> of converted values, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-convert.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_convert()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=foo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$tmp&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'author'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Joe&amp;nbsp;Thackery'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'year'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>2005</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'title'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'My&amp;nbsp;Life,&amp;nbsp;by&amp;nbsp;Joe&amp;nbsp;Thackery'<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$vals&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_convert</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'authors'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$tmp</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-convert.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-meta-data.php' class='function' rel='rdfs-seeAlso'>pg_meta_data()</a> - Get meta data for table</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_connection_status" value="<div id='function.pg-connection-status' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-connection-status.php'>pg_connection_status</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_connection_status</span> &amp;mdash; <span class='dc-title'> Get connection status </span></p> </div> <a name='function.pg-connection-status.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>pg_connection_status</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_connection_status()</b> returns the status of the specified <i><tt class='parameter'>connection</tt></i> . </p> </div> <a name='function.pg-connection-status.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-connection-status.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> <b><tt class='constant'>PGSQL_CONNECTION_OK</tt></b> or <b><tt class='constant'>PGSQL_CONNECTION_BAD</tt></b>. </p> </div> <a name='function.pg-connection-status.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_connection_status()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stat&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connection_status</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$stat&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>PGSQL_CONNECTION_OK</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;status&amp;nbsp;ok'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;status&amp;nbsp;bad'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-connection-status.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-busy.php' class='function' rel='rdfs-seeAlso'>pg_connection_busy()</a> - Get connection is busy or not</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_connection_reset" value="<div id='function.pg-connection-reset' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-connection-reset.php'>pg_connection_reset</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_connection_reset</span> &amp;mdash; <span class='dc-title'> Reset connection (reconnect) </span></p> </div> <a name='function.pg-connection-reset.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_connection_reset</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_connection_reset()</b> resets the connection. It is useful for error recovery. </p> </div> <a name='function.pg-connection-reset.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-connection-reset.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-connection-reset.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_connection_reset()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dbconn2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connection_reset</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$dbconn2</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'reset&amp;nbsp;successful\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'reset&amp;nbsp;failed\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-connection-reset.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function' rel='rdfs-seeAlso'>pg_pconnect()</a> - Open a persistent PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-status.php' class='function' rel='rdfs-seeAlso'>pg_connection_status()</a> - Get connection status</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_connection_busy" value="<div id='function.pg-connection-busy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-connection-busy.php'>pg_connection_busy</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_connection_busy</span> &amp;mdash; <span class='dc-title'> Get connection is busy or not </span></p> </div> <a name='function.pg-connection-busy.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_connection_busy</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_connection_busy()</b> determines whether or not a connection is busy. If it is busy, a previous query is still executing. If <a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function'>pg_get_result()</a> is used on the connection, it will be blocked. </p> </div> <a name='function.pg-connection-busy.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-connection-busy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the connection is busy, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.pg-connection-busy.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_connection_busy()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$bs&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$bs</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'connection&amp;nbsp;is&amp;nbsp;busy'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'connection&amp;nbsp;is&amp;nbsp;not&amp;nbsp;busy'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-connection-busy.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-status.php' class='function' rel='rdfs-seeAlso'>pg_connection_status()</a> - Get connection status</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-get-result.php' class='function' rel='rdfs-seeAlso'>pg_get_result()</a> - Get asynchronous query result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_connect" value="<div id='function.pg-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-connect.php'>pg_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_connect</span> &amp;mdash; <span class='dc-title'>Open a PostgreSQL connection</span></p> </div> <a name='function.pg-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>pg_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$connection_string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$connect_type</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_connect()</b> opens a connection to a PostgreSQL database specified by the <i><tt class='parameter'>connection_string</tt></i> . </p> <p class='para'> If a second call is made to <b>pg_connect()</b> with the same <i><tt class='parameter'>connection_string</tt></i> as an existing connection, the existing connection will be returned unless you pass <b><tt class='constant'>PGSQL_CONNECT_FORCE_NEW</tt></b> as <i><tt class='parameter'>connect_type</tt></i> . </p> <p class='para'> The old syntax with multiple parameters <strong class='command'>$conn = pg_connect(&amp;quot;host&amp;quot;, &amp;quot;port&amp;quot;, &amp;quot;options&amp;quot;, &amp;quot;tty&amp;quot;, &amp;quot;dbname&amp;quot;) </strong> has been deprecated. </p> </div> <a name='function.pg-connect.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'>connection_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>connection_string</tt></i> can be empty to use all default parameters, or it can contain one or more parameter settings separated by whitespace. Each parameter setting is in the form <i>keyword = value</i>. Spaces around the equal sign are optional. To write an empty value or a value containing spaces, surround it with single quotes, e.g., <i>keyword = &amp;#039;a value&amp;#039;</i>. Single quotes and backslashes within the value must be escaped with a backslash, i.e., \&amp;#039; and \\. </p> <p class='para'> The currently recognized parameter keywords are: <i><tt class='parameter'>host</tt></i> , <i><tt class='parameter'>hostaddr</tt></i> , <i><tt class='parameter'>port</tt></i> , <i><tt class='parameter'>dbname</tt></i> , <i><tt class='parameter'>user</tt></i> , <i><tt class='parameter'>password</tt></i> , <i><tt class='parameter'>connect_timeout</tt></i> , <i><tt class='parameter'>options</tt></i> , <i><tt class='parameter'>tty</tt></i> (ignored), <i><tt class='parameter'>sslmode</tt></i> , <i><tt class='parameter'>requiressl</tt></i> (deprecated in favor of <i><tt class='parameter'>sslmode</tt></i> ), and <i><tt class='parameter'>service</tt></i> . Which of these arguments exist depends on your PostgreSQL version. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>connect_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <b><tt class='constant'>PGSQL_CONNECT_FORCE_NEW</tt></b> is passed, then a new connection is created, even if the <i><tt class='parameter'>connection_string</tt></i> is identical to an existing connection. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> PostgreSQL connection resource on success, <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>pg_connect()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=mary'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'<br /><br /></span><span style='color: #0000BB'>$dbconn2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=mary'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'&amp;nbsp;on&amp;nbsp;'localhost'&amp;nbsp;at&amp;nbsp;port&amp;nbsp;'5432'<br /><br /></span><span style='color: #0000BB'>$dbconn3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=sheep&amp;nbsp;port=5432&amp;nbsp;dbname=mary&amp;nbsp;user=lamb&amp;nbsp;password=foo'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'mary'&amp;nbsp;on&amp;nbsp;the&amp;nbsp;host&amp;nbsp;'sheep'&amp;nbsp;with&amp;nbsp;a&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /><br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'host=sheep&amp;nbsp;port=5432&amp;nbsp;dbname=test&amp;nbsp;user=lamb&amp;nbsp;password=bar'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$dbconn4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//connect&amp;nbsp;to&amp;nbsp;a&amp;nbsp;database&amp;nbsp;named&amp;nbsp;'test'&amp;nbsp;on&amp;nbsp;the&amp;nbsp;host&amp;nbsp;'sheep'&amp;nbsp;with&amp;nbsp;a&amp;nbsp;username&amp;nbsp;and&amp;nbsp;password<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.pg-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function' rel='rdfs-seeAlso'>pg_pconnect()</a> - Open a persistent PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-close.php' class='function' rel='rdfs-seeAlso'>pg_close()</a> - Closes a PostgreSQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-host.php' class='function' rel='rdfs-seeAlso'>pg_host()</a> - Returns the host name associated with the connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-port.php' class='function' rel='rdfs-seeAlso'>pg_port()</a> - Return the port number associated with the connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-tty.php' class='function' rel='rdfs-seeAlso'>pg_tty()</a> - Return the TTY name associated with the connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-options.php' class='function' rel='rdfs-seeAlso'>pg_options()</a> - Get the options associated with the connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-dbname.php' class='function' rel='rdfs-seeAlso'>pg_dbname()</a> - Get the database name</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_close" value="<div id='function.pg-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-close.php'>pg_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_close</span> &amp;mdash; <span class='dc-title'>Closes a PostgreSQL connection</span></p> </div> <a name='function.pg-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_close</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>pg_close()</b> closes the non-persistent connection to a PostgreSQL database associated with the given <i><tt class='parameter'>connection</tt></i> resource. </p> <blockquote><p><b class='note'>Note</b>: Using <b>pg_close()</b> is not usually necessary, as non-persistent open connections are automatically closed at the end of the script. <br /> </p></blockquote> <p class='para'> If there is open large object resource on the connection, do not close the connection before closing all large object resources. </p> </div> <a name='function.pg-close.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_close()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'host=localhost&amp;nbsp;port=5432&amp;nbsp;dbname=mary'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Connected&amp;nbsp;successfully'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>pg_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connected successfully </pre></div> </div> </div><p> </p> </div> <a name='function.pg-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connect.php' class='function' rel='rdfs-seeAlso'>pg_connect()</a> - Open a PostgreSQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_client_encoding" value="<div id='function.pg-client-encoding' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-client-encoding.php'>pg_client_encoding</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.3, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_client_encoding</span> &amp;mdash; <span class='dc-title'> Gets the client encoding </span></p> </div> <a name='function.pg-client-encoding.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>pg_client_encoding</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> PostgreSQL supports automatic character set conversion between server and client for certain character sets. <b>pg_client_encoding()</b> returns the client encoding as a string. The returned string will be one of the standard PostgreSQL encoding identifiers. </p> <blockquote><p><b class='note'>Note</b>: This function requires PHP 4.0.3 or higher and PostgreSQL 7.0 or higher. If libpq is compiled without multibyte encoding support, <b>pg_client_encoding()</b> always returns <i>SQL_ASCII</i>. Supported encoding depends on PostgreSQL version. Refer to the PostgreSQL Documentation supported encodings. <br /> The function used to be called <b>pg_clientencoding()</b>. <br /> </p></blockquote> </div> <a name='function.pg-client-encoding.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. When <i><tt class='parameter'>connection</tt></i> is not present, the default connection is used. The default connection is the last connection made by <a href='http://www.php.net/manual/en/function.pg-connect.php' class='function'>pg_connect()</a> or <a href='http://www.php.net/manual/en/function.pg-pconnect.php' class='function'>pg_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-client-encoding.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The client encoding, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.pg-client-encoding.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_client_encoding()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Assume&amp;nbsp;$conn&amp;nbsp;is&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;to&amp;nbsp;a&amp;nbsp;ISO-8859-1&amp;nbsp;database<br /></span><span style='color: #0000BB'>$encoding&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_client_encoding</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Client&amp;nbsp;encoding&amp;nbsp;is:&amp;nbsp;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$encoding</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Client encoding is: ISO-8859-1 </pre></div> </div> </div><p> </p> </div> <a name='function.pg-client-encoding.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-set-client-encoding.php' class='function' rel='rdfs-seeAlso'>pg_set_client_encoding()</a> - Set the client encoding</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_cancel_query" value="<div id='function.pg-cancel-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-cancel-query.php'>pg_cancel_query</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_cancel_query</span> &amp;mdash; <span class='dc-title'> Cancel an asynchronous query </span></p> </div> <a name='function.pg-cancel-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>pg_cancel_query</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_cancel_query()</b> cancels an asynchronous query sent with <a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function'>pg_send_query()</a>, <a href='http://www.php.net/manual/en/function.pg-send-query-params.php' class='function'>pg_send_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-send-execute.php' class='function'>pg_send_execute()</a>. You cannot cancel a query executed using <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>. </p> </div> <a name='function.pg-cancel-query.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> PostgreSQL database connection resource. </p> </dd> </dl> <p> </p> </div> <a name='function.pg-cancel-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.pg-cancel-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_cancel_query()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$dbconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'dbname=publisher'</span><span style='color: #007700'>)&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(!</span><span style='color: #0000BB'>pg_connection_busy</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_send_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;authors;&amp;nbsp;select&amp;nbsp;count(*)&amp;nbsp;from&amp;nbsp;authors;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_get_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'First&amp;nbsp;call&amp;nbsp;to&amp;nbsp;pg_get_result():&amp;nbsp;</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rows1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$res1</span><span style='color: #DD0000'>&amp;nbsp;has&amp;nbsp;</span><span style='color: #0000BB'>$rows1</span><span style='color: #DD0000'>&amp;nbsp;records\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Cancel&amp;nbsp;the&amp;nbsp;currently&amp;nbsp;running&amp;nbsp;query.&amp;nbsp;&amp;nbsp;Will&amp;nbsp;be&amp;nbsp;the&amp;nbsp;second&amp;nbsp;query&amp;nbsp;if&amp;nbsp;it&amp;nbsp;is<br />&amp;nbsp;&amp;nbsp;//&amp;nbsp;still&amp;nbsp;running.<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>pg_cancel_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dbconn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> First call to pg_get_result(): Resource id #3 Resource id #3 has 3 records </pre></div> </div> </div><p> </p> </div> <a name='function.pg-cancel-query.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-send-query.php' class='function' rel='rdfs-seeAlso'>pg_send_query()</a> - Sends asynchronous query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-connection-busy.php' class='function' rel='rdfs-seeAlso'>pg_connection_busy()</a> - Get connection is busy or not</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="pg_affected_rows" value="<div id='function.pg-affected-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.pg-affected-rows.php'>pg_affected_rows</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>pg_affected_rows</span> &amp;mdash; <span class='dc-title'>Returns number of affected records (tuples)</span></p> </div> <a name='function.pg-affected-rows.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>pg_affected_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>pg_affected_rows()</b> returns the number of tuples (instances/records/rows) affected by <i>INSERT</i>, <i>UPDATE</i>, and <i>DELETE</i> queries. </p> <blockquote><p><b class='note'>Note</b>: This function used to be called <b>pg_cmdtuples()</b>. <br /> </p></blockquote> </div> <a name='function.pg-affected-rows.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'> PostgreSQL query result resource, returned by <a href='http://www.php.net/manual/en/function.pg-query.php' class='function'>pg_query()</a>, <a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function'>pg_query_params()</a> or <a href='http://www.php.net/manual/en/function.pg-execute.php' class='function'>pg_execute()</a> (among others). </p> </dd> </dl> <p> </p> </div> <a name='function.pg-affected-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The number of rows affected by the query. If no tuple is affected, it will return 0. </p> </div> <a name='function.pg-affected-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>pg_affected_rows()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;authors&amp;nbsp;VALUES&amp;nbsp;('Orwell',&amp;nbsp;2002,&amp;nbsp;'Animal&amp;nbsp;Farm')'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$cmdtuples&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>pg_affected_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$cmdtuples&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;tuples&amp;nbsp;are&amp;nbsp;affected.\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1 tuples are affected. </pre></div> </div> </div><p> </p> </div> <a name='function.pg-affected-rows.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query.php' class='function' rel='rdfs-seeAlso'>pg_query()</a> - Execute a query</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-query-params.php' class='function' rel='rdfs-seeAlso'>pg_query_params()</a> - Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-execute.php' class='function' rel='rdfs-seeAlso'>pg_execute()</a> - Sends a request to execute a prepared statement with given parameters, and waits for the result.</li> <li class='member'><a href='http://www.php.net/manual/en/function.pg-num-rows.php' class='function' rel='rdfs-seeAlso'>pg_num_rows()</a> - Returns the number of rows in a result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_tables" value="<div id='function.odbc-tables' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-tables.php'>odbc_tables</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_tables</span> &amp;mdash; <span class='dc-title'>Get the list of table names stored in a specific data source</span></p> </div> <a name='function.odbc-tables.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_tables</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$types</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Lists all tables in the requested range. </p> <p class='para'> To support enumeration of qualifiers, owners, and table types, the following special semantics for the <i><tt class='parameter'>qualifier</tt></i> , <i><tt class='parameter'>owner</tt></i> , <i><tt class='parameter'>name</tt></i> , and <i><tt class='parameter'>table_type</tt></i> are available: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> If <i><tt class='parameter'>qualifier</tt></i> is a single percent character (%) and <i><tt class='parameter'>owner</tt></i> and <i><tt class='parameter'>name</tt></i> are empty strings, then the result set contains a list of valid qualifiers for the data source. (All columns except the TABLE_QUALIFIER column contain NULLs.) </span> </li> <li class='listitem'> <span class='simpara'> If <i><tt class='parameter'>owner</tt></i> is a single percent character (%) and <i><tt class='parameter'>qualifier</tt></i> and <i><tt class='parameter'>name</tt></i> are empty strings, then the result set contains a list of valid owners for the data source. (All columns except the TABLE_OWNER column contain NULLs.) </span> </li> <li class='listitem'> <span class='simpara'> If <i><tt class='parameter'>table_type</tt></i> is a single percent character (%) and <i><tt class='parameter'>qualifier</tt></i> , <i><tt class='parameter'>owner</tt></i> and <i><tt class='parameter'>name</tt></i> are empty strings, then the result set contains a list of valid table types for the data source. (All columns except the TABLE_TYPE column contain NULLs.) </span> </li> </ul><p> </p> </div> <a name='function.odbc-tables.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. Accepts search patterns (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name. Accepts search patterns (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>types</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>table_type</tt></i> is not an empty string, it must contain a list of comma-separated values for the types of interest; each value may be enclosed in single quotes (&amp;#039;) or unquoted. For example, &amp;quot;&amp;#039;TABLE&amp;#039;,&amp;#039;VIEW&amp;#039;&amp;quot; or &amp;quot;TABLE, VIEW&amp;quot;. If the data source does not support a specified table type, <b>odbc_tables()</b> does not return any results for that type. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-tables.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier containing the information or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>TABLE_TYPE</span></li> <li class='listitem'><span class='simpara'>REMARKS</span></li> </ul><p> </p> <p class='simpara'> The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. </p> </div> <a name='function.odbc-tables.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-tableprivileges.php' class='function' rel='rdfs-seeAlso'>odbc_tableprivileges()</a> - Lists tables and the privileges associated with each table</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_tableprivileges" value="<div id='function.odbc-tableprivileges' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-tableprivileges.php'>odbc_tableprivileges</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_tableprivileges</span> &amp;mdash; <span class='dc-title'>Lists tables and the privileges associated with each table</span></p> </div> <a name='function.odbc-tableprivileges.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_tableprivileges</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$name</tt></span> )</div> <p class='para rdfs-comment'> Lists tables in the requested range and the privileges associated with each table. </p> </div> <a name='function.odbc-tableprivileges.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. Accepts the following search patterns: (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character) </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name. Accepts the following search patterns: (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character) </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-tableprivileges.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> An ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>GRANTOR</span></li> <li class='listitem'><span class='simpara'>GRANTEE</span></li> <li class='listitem'><span class='simpara'>PRIVILEGE</span></li> <li class='listitem'><span class='simpara'>IS_GRANTABLE</span></li> </ul><p> </p> <p class='simpara'> The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_statistics" value="<div id='function.odbc-statistics' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-statistics.php'>odbc_statistics</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_statistics</span> &amp;mdash; <span class='dc-title'>Retrieve statistics about a table</span></p> </div> <a name='function.odbc-statistics.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_statistics</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$unique</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$accuracy</tt></span> )</div> <p class='para rdfs-comment'> Get statistics about a table and its indexes. </p> </div> <a name='function.odbc-statistics.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The table name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>unique</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The unique attribute. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>accuracy</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The accuracy. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-statistics.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>NON_UNIQUE</span></li> <li class='listitem'><span class='simpara'>INDEX_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>INDEX_NAME</span></li> <li class='listitem'><span class='simpara'>TYPE</span></li> <li class='listitem'><span class='simpara'>SEQ_IN_INDEX</span></li> <li class='listitem'><span class='simpara'>COLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>COLLATION</span></li> <li class='listitem'><span class='simpara'>CARDINALITY</span></li> <li class='listitem'><span class='simpara'>PAGES</span></li> <li class='listitem'><span class='simpara'>FILTER_CONDITION</span></li> </ul><p> </p> <p class='simpara'> The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and SEQ_IN_INDEX. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_specialcolumns" value="<div id='function.odbc-specialcolumns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-specialcolumns.php'>odbc_specialcolumns</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_specialcolumns</span> &amp;mdash; <span class='dc-title'>Retrieves special columns</span></p> </div> <a name='function.odbc-specialcolumns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_specialcolumns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scope</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$nullable</tt></span> )</div> <p class='para rdfs-comment'> Retrieves either the optimal set of columns that uniquely identifies a row in the table, or columns that are automatically updated when any value in the row is updated by a transaction. </p> </div> <a name='function.odbc-specialcolumns.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <span class='simpara'> When the type argument is <b><tt class='constant'>SQL_BEST_ROWID</tt></b>, <b>odbc_specialcolumns()</b> returns the column or columns that uniquely identify each row in the table. </span> <span class='simpara'> When the type argument is <b><tt class='constant'>SQL_ROWVER</tt></b>, <b>odbc_specialcolumns()</b> returns the column or columns in the specified table, if any, that are automatically updated by the data source when any value in the row is updated by any transaction. </span> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The table. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>scope</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The scope, which orders the result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>nullable</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The nullable option. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-specialcolumns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>SCOPE</span></li> <li class='listitem'><span class='simpara'>COLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>DATA_TYPE</span></li> <li class='listitem'><span class='simpara'>TYPE_NAME</span></li> <li class='listitem'><span class='simpara'>PRECISION</span></li> <li class='listitem'><span class='simpara'>LENGTH</span></li> <li class='listitem'><span class='simpara'>SCALE</span></li> <li class='listitem'><span class='simpara'>PSEUDO_COLUMN</span></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_setoption" value="<div id='function.odbc-setoption' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-setoption.php'>odbc_setoption</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_setoption</span> &amp;mdash; <span class='dc-title'>Adjust ODBC settings</span></p> </div> <a name='function.odbc-setoption.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_setoption</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$function</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$option</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$param</tt></span> )</div> <p class='para rdfs-comment'> This function allows fiddling with the ODBC options for a particular connection or query result. It was written to help find work around to problems in quirky ODBC drivers. You should probably only use this function if you are an ODBC programmer and understand the effects the various options will have. You will certainly need a good ODBC reference to explain all the different options and values that can be used. Different driver versions support different options. </p> <p class='para'> Because the effects may vary depending on the ODBC driver, use of this function in scripts to be made publicly available is strongly discouraged. Also, some ODBC options are not available to this function because they must be set before the connection is established or the query is prepared. However, if on a particular job it can make PHP work so your boss doesn&amp;#039;t tell you to use a commercial product, that&amp;#039;s all that really matters. </p> </div> <a name='function.odbc-setoption.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'>id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Is a connection id or result id on which to change the settings. For SQLSetConnectOption(), this is a connection id. For SQLSetStmtOption(), this is a result id. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>function</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Is the ODBC function to use. The value should be 1 for SQLSetConnectOption() and 2 for SQLSetStmtOption(). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The option to set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>param</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value for the given <i><tt class='parameter'>option</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-setoption.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.odbc-setoption.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>odbc_setoption()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;1.&amp;nbsp;Option&amp;nbsp;102&amp;nbsp;of&amp;nbsp;SQLSetConnectOption()&amp;nbsp;is&amp;nbsp;SQL_AUTOCOMMIT.<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;Value&amp;nbsp;1&amp;nbsp;of&amp;nbsp;SQL_AUTOCOMMIT&amp;nbsp;is&amp;nbsp;SQL_AUTOCOMMIT_ON.<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;This&amp;nbsp;example&amp;nbsp;has&amp;nbsp;the&amp;nbsp;same&amp;nbsp;effect&amp;nbsp;as<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;odbc_autocommit($conn,&amp;nbsp;true);<br /><br /></span><span style='color: #0000BB'>odbc_setoption</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>102</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;2.&amp;nbsp;Option&amp;nbsp;0&amp;nbsp;of&amp;nbsp;SQLSetStmtOption()&amp;nbsp;is&amp;nbsp;SQL_QUERY_TIMEOUT.<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;This&amp;nbsp;example&amp;nbsp;sets&amp;nbsp;the&amp;nbsp;query&amp;nbsp;to&amp;nbsp;timeout&amp;nbsp;after&amp;nbsp;30&amp;nbsp;seconds.<br /><br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>odbc_setoption</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>30</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>odbc_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_rollback" value="<div id='function.odbc-rollback' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-rollback.php'>odbc_rollback</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_rollback</span> &amp;mdash; <span class='dc-title'>Rollback a transaction</span></p> </div> <a name='function.odbc-rollback.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_rollback</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> )</div> <p class='para rdfs-comment'> Rolls back all pending statements on the connection. </p> </div> <a name='function.odbc-rollback.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> </dl> <p> </p> </div> <a name='function.odbc-rollback.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_result_all" value="<div id='function.odbc-result-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-result-all.php'>odbc_result_all</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_result_all</span> &amp;mdash; <span class='dc-title'>Print result as HTML table</span></p> </div> <a name='function.odbc-result-all.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>odbc_result_all</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$format</tt></span> ] )</div> <p class='para rdfs-comment'> Prints all rows from a result identifier produced by <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. The result is printed in HTML table format. </p> </div> <a name='function.odbc-result-all.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>format</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Additional overall table formatting. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-result-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows in the result or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_result" value="<div id='function.odbc-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-result.php'>odbc_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_result</span> &amp;mdash; <span class='dc-title'>Get result data</span></p> </div> <a name='function.odbc-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>odbc_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Get result data </p> </div> <a name='function.odbc-result.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The ODBC <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field name being retrieved. It can either be an integer containing the column number of the field you want; or it can be a string containing the name of the field. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the string contents of the field, <b><tt class='constant'>FALSE</tt></b> on error, <b><tt class='constant'>NULL</tt></b> for NULL data, or <b><tt class='constant'>TRUE</tt></b> for binary data. </p> </div> <a name='function.odbc-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> The first call to <b>odbc_result()</b> returns the value of the third field in the current record of the query result. The second function call to <b>odbc_result()</b> returns the value of the field whose field name is &amp;quot;val&amp;quot; in the current record of the query result. An error occurs if a column number parameter for a field is less than one or exceeds the number of columns (or fields) in the current record. Similarly, an error occurs if a field with a name that is not one of the fieldnames of the table(s) that is(are) being queried. </p> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>odbc_result()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$item_3&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$Query_ID</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$item_val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$Query_ID</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'val'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.odbc-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <p class='para'> Field indices start from 1. Regarding the way binary or long column data is returned refer to <a href='http://www.php.net/manual/en/function.odbc-binmode.php' class='function'>odbc_binmode()</a> and <a href='http://www.php.net/manual/en/function.odbc-longreadlen.php' class='function'>odbc_longreadlen()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_procedures" value="<div id='function.odbc-procedures' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-procedures.php'>odbc_procedures</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_procedures</span> &amp;mdash; <span class='dc-title'>Get the list of procedures stored in a specific data source</span></p> </div> <a name='function.odbc-procedures.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_procedures</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_procedures</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$name</tt></span> )</div> <p class='para rdfs-comment'> Lists all procedures in the requested range. </p> </div> <a name='function.odbc-procedures.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. This parameter accepts the following search patterns: &amp;quot;%&amp;quot; to match zero or more characters, and &amp;quot;_&amp;quot; to match a single character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name. This parameter accepts the following search patterns: &amp;quot;%&amp;quot; to match zero or more characters, and &amp;quot;_&amp;quot; to match a single character. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-procedures.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier containing the information or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>PROCEDURE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>PROCEDURE_OWNER</span></li> <li class='listitem'><span class='simpara'>PROCEDURE_NAME</span></li> <li class='listitem'><span class='simpara'>NUM_INPUT_PARAMS</span></li> <li class='listitem'><span class='simpara'>NUM_OUTPUT_PARAMS</span></li> <li class='listitem'><span class='simpara'>NUM_RESULT_SETS</span></li> <li class='listitem'><span class='simpara'>REMARKS</span></li> <li class='listitem'><span class='simpara'>PROCEDURE_TYPE</span></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_procedurecolumns" value="<div id='function.odbc-procedurecolumns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-procedurecolumns.php'>odbc_procedurecolumns</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_procedurecolumns</span> &amp;mdash; <span class='dc-title'>Retrieve information about parameters to procedures</span></p> </div> <a name='function.odbc-procedurecolumns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_procedurecolumns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_procedurecolumns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$proc</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Retrieve information about parameters to procedures. </p> </div> <a name='function.odbc-procedurecolumns.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. This parameter accepts the following search patterns: &amp;quot;%&amp;quot; to match zero or more characters, and &amp;quot;_&amp;quot; to match a single character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>proc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The proc. This parameter accepts the following search patterns: &amp;quot;%&amp;quot; to match zero or more characters, and &amp;quot;_&amp;quot; to match a single character. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The column. This parameter accepts the following search patterns: &amp;quot;%&amp;quot; to match zero or more characters, and &amp;quot;_&amp;quot; to match a single character. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-procedurecolumns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>PROCEDURE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>PROCEDURE_OWNER</span></li> <li class='listitem'><span class='simpara'>PROCEDURE_NAME</span></li> <li class='listitem'><span class='simpara'>COLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>COLUMN_TYPE</span></li> <li class='listitem'><span class='simpara'>DATA_TYPE</span></li> <li class='listitem'><span class='simpara'>TYPE_NAME</span></li> <li class='listitem'><span class='simpara'>PRECISION</span></li> <li class='listitem'><span class='simpara'>LENGTH</span></li> <li class='listitem'><span class='simpara'>SCALE</span></li> <li class='listitem'><span class='simpara'>RADIX</span></li> <li class='listitem'><span class='simpara'>NULLABLE</span></li> <li class='listitem'><span class='simpara'>REMARKS</span></li> </ul><p> </p> <p class='simpara'> The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, PROCEDURE_NAME and COLUMN_TYPE. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_primarykeys" value="<div id='function.odbc-primarykeys' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-primarykeys.php'>odbc_primarykeys</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_primarykeys</span> &amp;mdash; <span class='dc-title'>Gets the primary keys for a table</span></p> </div> <a name='function.odbc-primarykeys.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_primarykeys</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table</tt></span> )</div> <p class='para rdfs-comment'> Returns a result identifier that can be used to fetch the column names that comprise the primary key for a table. </p> </div> <a name='function.odbc-primarykeys.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-primarykeys.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>COLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>KEY_SEQ</span></li> <li class='listitem'><span class='simpara'>PK_NAME</span></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_prepare" value="<div id='function.odbc-prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-prepare.php'>odbc_prepare</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_prepare</span> &amp;mdash; <span class='dc-title'>Prepares a statement for execution</span></p> </div> <a name='function.odbc-prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_prepare</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query_string</tt></span> )</div> <p class='para rdfs-comment'> Prepares a statement for execution. The result identifier can be used later to execute the statement with <a href='http://www.php.net/manual/en/function.odbc-execute.php' class='function'>odbc_execute()</a>. </p> <p class='para'> Some databases (such as IBM DB2, MS SQL Server, and Oracle) support stored procedures that accept parameters of type IN, INOUT, and OUT as defined by the ODBC specification. However, the Unified ODBC driver currently only supports parameters of type IN to stored procedures. </p> </div> <a name='function.odbc-prepare.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The query string statement being prepared. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-prepare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier if the SQL command was prepared successfully. Returns <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.odbc-prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <a href='http://www.php.net/manual/en/function.odbc-execute.php' class='function'>odbc_execute()</a> and <b>odbc_prepare()</b> example</b></p> <div class='example-contents para'><p> In the following code, <var class='varname'>$success</var> will only be <b><tt class='constant'>TRUE</tt></b> if all three parameters to myproc are IN parameters: </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$c&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CALL&amp;nbsp;myproc(?,?,?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$success&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> If you need to call a stored procedure using INOUT or OUT parameters, the recommended workaround is to use a native extension for your database (for example, <a href='http://www.php.net/manual/en/ref.mssql.php' class='link'>mssql</a> for MS SQL Server, or <a href='http://www.php.net/manual/en/ref.mssql.php' class='link'>oci8</a> for Oracle). </p> </div> <a name='function.odbc-prepare.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-execute.php' class='function' rel='rdfs-seeAlso'>odbc_execute()</a> - Execute a prepared statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_pconnect" value="<div id='function.odbc-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-pconnect.php'>odbc_pconnect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_pconnect</span> &amp;mdash; <span class='dc-title'>Open a persistent database connection</span></p> </div> <a name='function.odbc-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_pconnect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dsn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$user</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cursor_type</tt></span> ] )</div> <p class='para rdfs-comment'> Opens a persistent database connection. </p> <p class='para'> This function is much like <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a>, except that the connection is not really closed when the script has finished. Future requests for a connection with the same <i><tt class='parameter'>dsn</tt></i> , <i><tt class='parameter'>user</tt></i> , <i><tt class='parameter'>password</tt></i> combination (via <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> and <b>odbc_pconnect()</b>) can reuse the persistent connection. </p> </div> <a name='function.odbc-pconnect.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'> See <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details. </p> </div> <a name='function.odbc-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC connection id or 0 (<b><tt class='constant'>FALSE</tt></b>) on error. </p> </div> <a name='function.odbc-pconnect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> Persistent connections have no effect if PHP is used as a CGI program. </span> </p></blockquote> </div> <a name='function.odbc-pconnect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function' rel='rdfs-seeAlso'>odbc_connect()</a> - Connect to a datasource</li> <li class='member'><a href='http://www.php.net/manual/en/features.persistent-connections.php' class='link'>Persistent Database Connections</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_num_rows" value="<div id='function.odbc-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-num-rows.php'>odbc_num_rows</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_num_rows</span> &amp;mdash; <span class='dc-title'>Number of rows in a result</span></p> </div> <a name='function.odbc-num-rows.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>odbc_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of rows in a result. For INSERT, UPDATE and DELETE statements <b>odbc_num_rows()</b> returns the number of rows affected. For a SELECT clause this <i>can</i> be the number of rows available. </p> </div> <a name='function.odbc-num-rows.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier returned by <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows in an ODBC result. This function will return -1 on error. </p> </div> <a name='function.odbc-num-rows.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Using <b>odbc_num_rows()</b> to determine the number of rows available after a SELECT will return -1 with many drivers. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_num_fields" value="<div id='function.odbc-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-num-fields.php'>odbc_num_fields</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_num_fields</span> &amp;mdash; <span class='dc-title'>Number of columns in a result</span></p> </div> <a name='function.odbc-num-fields.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>odbc_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of fields (columns) in an ODBC result. </p> </div> <a name='function.odbc-num-fields.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier returned by <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of fields, or -1 on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_next_result" value="<div id='function.odbc-next-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-next-result.php'>odbc_next_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_next_result</span> &amp;mdash; <span class='dc-title'>Checks if multiple results are available</span></p> </div> <a name='function.odbc-next-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_next_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Checks if there are more result sets available as well as allowing access to the next result set via <a href='http://www.php.net/manual/en/function.odbc-fetch-array.php' class='function'>odbc_fetch_array()</a>, <a href='http://www.php.net/manual/en/function.odbc-fetch-row.php' class='function'>odbc_fetch_row()</a>, <a href='http://www.php.net/manual/en/function.odbc-result.php' class='function'>odbc_result()</a>, etc. </p> </div> <a name='function.odbc-next-result.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-next-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if there are more result sets, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.odbc-next-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>odbc_next_result()</b></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$r_Connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dsn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$username</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$s_SQL&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;lt;&amp;lt;&amp;lt;END_SQL<br /></span><span style='color: #DD0000'>SELECT&amp;nbsp;'A'<br />SELECT&amp;nbsp;'B'<br />SELECT&amp;nbsp;'C'<br /></span><span style='color: #007700'>END_SQL;<br /><br /></span><span style='color: #0000BB'>$r_Results&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$s_SQL</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$a_Row1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$a_Row2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Dump&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a_Row1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a_Row2</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Get&amp;nbsp;second&amp;nbsp;results&amp;nbsp;set&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>odbc_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>$a_Row1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$a_Row2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Dump&amp;nbsp;second&amp;nbsp;result&amp;nbsp;set&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a_Row1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a_Row2</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Get&amp;nbsp;third&amp;nbsp;results&amp;nbsp;set&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>odbc_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>$a_Row1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$a_Row2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Dump&amp;nbsp;third&amp;nbsp;result&amp;nbsp;set&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$a_Row1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$a_Row2</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Try&amp;nbsp;for&amp;nbsp;a&amp;nbsp;fourth&amp;nbsp;result&amp;nbsp;set&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>odbc_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$r_Results</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Dump first result set array(1) { [&amp;quot;A&amp;quot;]=&amp;gt; string(1) &amp;quot;A&amp;quot; } bool(false) Get second results set bool(true) Dump second result set array(1) { [&amp;quot;B&amp;quot;]=&amp;gt; string(1) &amp;quot;B&amp;quot; } bool(false) Get third results set bool(true) Dump third result set array(1) { [&amp;quot;C&amp;quot;]=&amp;gt; string(1) &amp;quot;C&amp;quot; } bool(false) Try for a fourth result set bool(false) </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_longreadlen" value="<div id='function.odbc-longreadlen' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-longreadlen.php'>odbc_longreadlen</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_longreadlen</span> &amp;mdash; <span class='dc-title'>Handling of LONG columns</span></p> </div> <a name='function.odbc-longreadlen.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_longreadlen</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> )</div> <p class='para rdfs-comment'> Enables handling of LONG and LONGVARBINARY columns. </p> </div> <a name='function.odbc-longreadlen.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of bytes returned to PHP is controlled by the parameter length. If it is set to 0, Long column data is passed through to the client. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-longreadlen.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.odbc-longreadlen.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Handling of LONGVARBINARY columns is also affected by <a href='http://www.php.net/manual/en/function.odbc-binmode.php' class='function'>odbc_binmode()</a>. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_gettypeinfo" value="<div id='function.odbc-gettypeinfo' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-gettypeinfo.php'>odbc_gettypeinfo</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_gettypeinfo</span> &amp;mdash; <span class='dc-title'>Retrieves information about data types supported by the data source</span></p> </div> <a name='function.odbc-gettypeinfo.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_gettypeinfo</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$data_type</tt></span> ] )</div> <p class='para rdfs-comment'> Retrieves information about data types supported by the data source. </p> </div> <a name='function.odbc-gettypeinfo.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data type, which can be used to restrict the information to a single data type. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-gettypeinfo.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TYPE_NAME</span></li> <li class='listitem'><span class='simpara'>DATA_TYPE</span></li> <li class='listitem'><span class='simpara'>PRECISION</span></li> <li class='listitem'><span class='simpara'>LITERAL_PREFIX</span></li> <li class='listitem'><span class='simpara'>LITERAL_SUFFIX</span></li> <li class='listitem'><span class='simpara'>CREATE_PARAMS</span></li> <li class='listitem'><span class='simpara'>NULLABLE</span></li> <li class='listitem'><span class='simpara'>CASE_SENSITIVE</span></li> <li class='listitem'><span class='simpara'>SEARCHABLE</span></li> <li class='listitem'><span class='simpara'>UNSIGNED_ATTRIBUTE</span></li> <li class='listitem'><span class='simpara'>MONEY</span></li> <li class='listitem'><span class='simpara'>AUTO_INCREMENT</span></li> <li class='listitem'><span class='simpara'>LOCAL_TYPE_NAME</span></li> <li class='listitem'><span class='simpara'>MINIMUM_SCALE</span></li> <li class='listitem'><span class='simpara'>MAXIMUM_SCALE</span></li> </ul><p> </p> <p class='para'> The result set is ordered by DATA_TYPE and TYPE_NAME. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_free_result" value="<div id='function.odbc-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-free-result.php'>odbc_free_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_free_result</span> &amp;mdash; <span class='dc-title'>Free resources associated with a result</span></p> </div> <a name='function.odbc-free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Free resources associated with a result. </p> <p class='para'> <b>odbc_free_result()</b> only needs to be called if you are worried about using too much memory while your script is running. All result memory will automatically be freed when the script is finished. </p> </div> <a name='function.odbc-free-result.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Always returns <b><tt class='constant'>TRUE</tt></b>. </p> </div> <a name='function.odbc-free-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If auto-commit is disabled (see <a href='http://www.php.net/manual/en/function.odbc-autocommit.php' class='function'>odbc_autocommit()</a>) and you call <b>odbc_free_result()</b> before committing, all pending transactions are rolled back. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_foreignkeys" value="<div id='function.odbc-foreignkeys' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-foreignkeys.php'>odbc_foreignkeys</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_foreignkeys</span> &amp;mdash; <span class='dc-title'>Retrieves a list of foreign keys</span></p> </div> <a name='function.odbc-foreignkeys.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_foreignkeys</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pk_qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pk_owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$pk_table</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fk_qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fk_owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$fk_table</tt></span> )</div> <p class='para rdfs-comment'> Retrieves a list of foreign keys in the specified table or a list of foreign keys in other tables that refer to the primary key in the specified table </p> </div> <a name='function.odbc-foreignkeys.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pk_qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The primary key qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pk_owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The primary key owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>pk_table</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The primary key table. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fk_qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The foreign key qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fk_owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The foreign key owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fk_table</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The foreign key table. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-foreignkeys.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>PKTABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>PKTABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>PKTABLE_NAME</span></li> <li class='listitem'><span class='simpara'>PKCOLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>FKTABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>FKTABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>FKTABLE_NAME</span></li> <li class='listitem'><span class='simpara'>FKCOLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>KEY_SEQ</span></li> <li class='listitem'><span class='simpara'>UPDATE_RULE</span></li> <li class='listitem'><span class='simpara'>DELETE_RULE</span></li> <li class='listitem'><span class='simpara'>FK_NAME</span></li> <li class='listitem'><span class='simpara'>PK_NAME</span></li> </ul><p> </p> <p class='simpara'> If <i><tt class='parameter'>pk_table</tt></i> contains a table name, <b>odbc_foreignkeys()</b> returns a result set containing the primary key of the specified table and all of the foreign keys that refer to it. </p> <p class='simpara'> If <i><tt class='parameter'>fk_table</tt></i> contains a table name, <b>odbc_foreignkeys()</b> returns a result set containing all of the foreign keys in the specified table and the primary keys (in other tables) to which they refer. </p> <p class='simpara'> If both <i><tt class='parameter'>pk_table</tt></i> and <i><tt class='parameter'>fk_table</tt></i> contain table names, <b>odbc_foreignkeys()</b> returns the foreign keys in the table specified in <i><tt class='parameter'>fk_table</tt></i> that refer to the primary key of the table specified in <i><tt class='parameter'>pk_table</tt></i> . This should be one key at most. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_type" value="<div id='function.odbc-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-type.php'>odbc_field_type</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_type</span> &amp;mdash; <span class='dc-title'>Datatype of a field</span></p> </div> <a name='function.odbc-field-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>odbc_field_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> Gets the SQL type of the field referenced by number in the given result identifier. </p> </div> <a name='function.odbc-field-type.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. Field numbering starts at 1. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field type as a string, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_scale" value="<div id='function.odbc-field-scale' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-scale.php'>odbc_field_scale</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_scale</span> &amp;mdash; <span class='dc-title'>Get the scale of a field</span></p> </div> <a name='function.odbc-field-scale.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>odbc_field_scale</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> Gets the scale of the field referenced by number in the given result identifier. </p> </div> <a name='function.odbc-field-scale.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. Field numbering starts at 1. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-field-scale.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field scale as a integer, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_precision" value="<div id='function.odbc-field-precision' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-precision.php'>odbc_field_precision</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_precision</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.odbc-field-len.php' class='function'>odbc_field_len()</a></span></p> </div> <a name='function.odbc-field-precision.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of: <a href='http://www.php.net/manual/en/function.odbc-field-len.php' class='function'>odbc_field_len()</a>. </p> </div> <a name='function.odbc-field-precision.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-field-scale.php' class='function' rel='rdfs-seeAlso'>odbc_field_scale()</a> - Get the scale of a field to get the scale of a floating point number.</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_num" value="<div id='function.odbc-field-num' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-num.php'>odbc_field_num</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_num</span> &amp;mdash; <span class='dc-title'>Return column number</span></p> </div> <a name='function.odbc-field-num.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>odbc_field_num</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$field_name</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of the column slot that corresponds to the named field in the given result identifier. </p> </div> <a name='function.odbc-field-num.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field name. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-field-num.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field number as a integer, or <b><tt class='constant'>FALSE</tt></b> on error. Field numbering starts at 1. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_name" value="<div id='function.odbc-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-name.php'>odbc_field_name</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_name</span> &amp;mdash; <span class='dc-title'>Get the columnname</span></p> </div> <a name='function.odbc-field-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>odbc_field_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> Gets the name of the field occupying the given column number in the given result identifier. </p> </div> <a name='function.odbc-field-name.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. Field numbering starts at 1. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-field-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field name as a string, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_field_len" value="<div id='function.odbc-field-len' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-field-len.php'>odbc_field_len</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_field_len</span> &amp;mdash; <span class='dc-title'>Get the length (precision) of a field</span></p> </div> <a name='function.odbc-field-len.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>odbc_field_len</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field_number</tt></span> )</div> <p class='para rdfs-comment'> Gets the length of the field referenced by number in the given result identifier. </p> </div> <a name='function.odbc-field-len.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field number. Field numbering starts at 1. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-field-len.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field name as a string, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.odbc-field-len.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-field-scale.php' class='function' rel='rdfs-seeAlso'>odbc_field_scale()</a> - Get the scale of a field to get the scale of a floating point number</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_fetch_row" value="<div id='function.odbc-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-fetch-row.php'>odbc_fetch_row</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_fetch_row</span> &amp;mdash; <span class='dc-title'>Fetch a row</span></p> </div> <a name='function.odbc-fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_fetch_row</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt></span> ] )</div> <p class='para rdfs-comment'> Fetches a row of the data that was returned by <a href='http://www.php.net/manual/en/function.odbc-do.php' class='function'>odbc_do()</a> or <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. After <b>odbc_fetch_row()</b> is called, the fields of that row can be accessed with <a href='http://www.php.net/manual/en/function.odbc-result.php' class='function'>odbc_result()</a>. </p> </div> <a name='function.odbc-fetch-row.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>row_number</tt></i> is not specified, <b>odbc_fetch_row()</b> will try to fetch the next row in the result set. Calls to <b>odbc_fetch_row()</b> with and without <i><tt class='parameter'>row_number</tt></i> can be mixed. </p> <p class='para'> To step through the result more than once, you can call <b>odbc_fetch_row()</b> with <i><tt class='parameter'>row_number</tt></i> 1, and then continue doing <b>odbc_fetch_row()</b> without <i><tt class='parameter'>row_number</tt></i> to review the result. If a driver doesn&amp;#039;t support fetching rows by number, the <i><tt class='parameter'>row_number</tt></i> parameter is ignored. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if there was a row, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_fetch_object" value="<div id='function.odbc-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-fetch-object.php'>odbc_fetch_object</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.2, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_fetch_object</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an object</span></p> </div> <a name='function.odbc-fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>odbc_fetch_object</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'>$rownumber</tt></span> ] )</div> <p class='para rdfs-comment'> Fetch an <a href='http://www.php.net/manual/en/language.types.object.php' class='type object'>object</a> from an ODBC query. See the changelog below for when this function is available. </p> </div> <a name='function.odbc-fetch-object.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 from <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rownumber</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Optionally choose which row number to retrieve. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.odbc-fetch-object.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.3</td> <td align='left'> This function exists when compiled with IBM DB2 or UnixODBC support. </td> </tr> <tr valign='middle'> <td align='left'>4.3.2</td> <td align='left'> This function exists when compiled for Windows. </td> </tr> <tr valign='middle'> <td align='left'>4.0.2</td> <td align='left'> This function exists when compiled with DBMaker support. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.odbc-fetch-object.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-fetch-row.php' class='function' rel='rdfs-seeAlso'>odbc_fetch_row()</a> - Fetch a row</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-fetch-array.php' class='function' rel='rdfs-seeAlso'>odbc_fetch_array()</a> - Fetch a result row as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-num-rows.php' class='function' rel='rdfs-seeAlso'>odbc_num_rows()</a> - Number of rows in a result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_fetch_into" value="<div id='function.odbc-fetch-into' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-fetch-into.php'>odbc_fetch_into</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_fetch_into</span> &amp;mdash; <span class='dc-title'>Fetch one result row into array</span></p> </div> <a name='function.odbc-fetch-into.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>odbc_fetch_into</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$result_array</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$rownumber</tt></span> ] )</div> <p class='para rdfs-comment'> Fetch one result row into <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a>. </p> </div> <a name='function.odbc-fetch-into.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> that can be of any type since it will be converted to type array. The array will contain the column values starting at array index 0. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rownumber</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The row number. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-fetch-into.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of columns in the result; <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.odbc-fetch-into.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> The <i><tt class='parameter'>result_array</tt></i> and <i><tt class='parameter'>rownumber</tt></i> parameters have been swapped. This allows the rownumber to be a constant again. </td> </tr> <tr valign='middle'> <td align='left'>4.0.6</td> <td align='left'> The <i><tt class='parameter'>rownumber</tt></i> can no longer be passed in as a constant, but rather as a variable. This again changed in 4.2.0. </td> </tr> <tr valign='middle'> <td align='left'>4.0.5</td> <td align='left'> The <i><tt class='parameter'>result_array</tt></i> parameter no longer needs to be passed in by reference. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.odbc-fetch-into.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>odbc_fetch_into()</b> examples</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_into</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$my_array</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p> or </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_fetch_into</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res_id</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$my_array</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_fetch_array" value="<div id='function.odbc-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-fetch-array.php'>odbc_fetch_array</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.2, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_fetch_array</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative array</span></p> </div> <a name='function.odbc-fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>odbc_fetch_array</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'>$rownumber</tt></span> ] )</div> <p class='para rdfs-comment'> Fetch an associative <a href='http://www.php.net/manual/en/language.types.array.php' class='type array'>array</a> from an ODBC query. See the changelog below for when this function is available. </p> </div> <a name='function.odbc-fetch-array.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 from <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rownumber</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Optionally choose which row number to retrieve. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.odbc-fetch-array.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3.3</td> <td align='left'> This function exists when compiled with IBM DB2 or UnixODBC support. </td> </tr> <tr valign='middle'> <td align='left'>4.3.2</td> <td align='left'> This function exists when compiled for Windows. </td> </tr> <tr valign='middle'> <td align='left'>4.0.2</td> <td align='left'> This function exists when compiled with DBMaker support. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.odbc-fetch-array.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-fetch-row.php' class='function' rel='rdfs-seeAlso'>odbc_fetch_row()</a> - Fetch a row</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-fetch-object.php' class='function' rel='rdfs-seeAlso'>odbc_fetch_object()</a> - Fetch a result row as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-num-rows.php' class='function' rel='rdfs-seeAlso'>odbc_num_rows()</a> - Number of rows in a result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_execute" value="<div id='function.odbc-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-execute.php'>odbc_execute</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_execute</span> &amp;mdash; <span class='dc-title'>Execute a prepared statement</span></p> </div> <a name='function.odbc-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_execute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$parameters_array</tt></span> ] )</div> <p class='para rdfs-comment'> Executes a statement prepared with <a href='http://www.php.net/manual/en/function.odbc-prepare.php' class='function'>odbc_prepare()</a>. </p> </div> <a name='function.odbc-execute.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result id <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a>, from <a href='http://www.php.net/manual/en/function.odbc-prepare.php' class='function'>odbc_prepare()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>parameters_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Parameters in <i><tt class='parameter'>parameter_array</tt></i> will be substituted for placeholders in the prepared statement in order. Elements of this array will be converted to strings by calling this function. </p> <p class='para'> Any parameters in <i><tt class='parameter'>parameter_array</tt></i> which start and end with single quotes will be taken as the name of a file to read and send to the database server as the data for the appropriate placeholder. </p> <span class='simpara'> If you wish to store a string which actually begins and ends with single quotes, you must add a space or other non-single-quote character to the beginning or end of the parameter, which will prevent the parameter from being taken as a file name. If this is not an option, then you must use another mechanism to store the string, such as executing the query directly with <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>). </span> </dd> </dl> <p> </p> </div> <a name='function.odbc-execute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.odbc-execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>odbc_execute()</b> and <a href='http://www.php.net/manual/en/function.odbc-prepare.php' class='function'>odbc_prepare()</a> example</b></p> <div class='example-contents para'><p> In the following code, <var class='varname'>$success</var> will only be <b><tt class='constant'>TRUE</tt></b> if all three parameters to myproc are IN parameters: </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$a&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$b&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$c&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CALL&amp;nbsp;myproc(?,?,?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$success&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>$a</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$b</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> If you need to call a stored procedure using INOUT or OUT parameters, the recommended workaround is to use a native extension for your database (for example, <a href='http://www.php.net/manual/en/ref.mssql.php' class='link'>mssql</a> for MS SQL Server, or <a href='http://www.php.net/manual/en/ref.mssql.php' class='link'>oci8</a> for Oracle). </p> </div> <a name='function.odbc-execute.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.2.0</td> <td align='left'> File reading is now subject to <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.safe-mode' class='link'>safe mode</a> and <a href='http://www.php.net/manual/en/ini.sect.safe-mode.php#ini.open-basedir' class='link'>open-basedir</a> restrictions in <i><tt class='parameter'>parameters_array</tt></i> . </td> </tr> <tr valign='middle'> <td align='left'>4.1.1</td> <td align='left'> <a href='http://www.php.net/manual/en/features.remote-files.php' class='link'>Remote files</a> are no longer supported in <i><tt class='parameter'>parameters_array</tt></i> . </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.odbc-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-prepare.php' class='function' rel='rdfs-seeAlso'>odbc_prepare()</a> - Prepares a statement for execution</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_exec" value="<div id='function.odbc-exec' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-exec.php'>odbc_exec</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_exec</span> &amp;mdash; <span class='dc-title'>Prepare and execute a SQL statement</span></p> </div> <a name='function.odbc-exec.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_exec</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query_string</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt></span> ] )</div> <p class='para rdfs-comment'> Sends an SQL statement to the database server. </p> </div> <a name='function.odbc-exec.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query_string</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The SQL statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter is currently not used. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-exec.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier if the SQL command was executed successfully, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.odbc-exec.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-prepare.php' class='function' rel='rdfs-seeAlso'>odbc_prepare()</a> - Prepares a statement for execution</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-execute.php' class='function' rel='rdfs-seeAlso'>odbc_execute()</a> - Execute a prepared statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_errormsg" value="<div id='function.odbc-errormsg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-errormsg.php'>odbc_errormsg</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_errormsg</span> &amp;mdash; <span class='dc-title'>Get the last error message</span></p> </div> <a name='function.odbc-errormsg.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>odbc_errormsg</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> ] )</div> <p class='simpara'> Returns a string containing the last ODBC error message, or an empty string if there has been no errors. </p> </div> <a name='function.odbc-errormsg.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> </dl> <p> </p> </div> <a name='function.odbc-errormsg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>connection_id</tt></i> is specified, the last state of that connection is returned, else the last state of any connection is returned. </p> <p class='para'> This function returns meaningful value only if last odbc query failed (i.e. <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a> returned <b><tt class='constant'>FALSE</tt></b>). </p> </div> <a name='function.odbc-errormsg.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-error.php' class='function' rel='rdfs-seeAlso'>odbc_error()</a> - Get the last error code</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function' rel='rdfs-seeAlso'>odbc_exec()</a> - Prepare and execute a SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_error" value="<div id='function.odbc-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-error.php'>odbc_error</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_error</span> &amp;mdash; <span class='dc-title'>Get the last error code</span></p> </div> <a name='function.odbc-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>odbc_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> ] )</div> <p class='simpara'> Returns a six-digit ODBC state, or an empty string if there has been no errors. </p> </div> <a name='function.odbc-error.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> </dl> <p> </p> </div> <a name='function.odbc-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If <i><tt class='parameter'>connection_id</tt></i> is specified, the last state of that connection is returned, else the last state of any connection is returned. </p> <p class='para'> This function returns meaningful value only if last odbc query failed (i.e. <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a> returned <b><tt class='constant'>FALSE</tt></b>). </p> </div> <a name='function.odbc-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-errormsg.php' class='function' rel='rdfs-seeAlso'>odbc_errormsg()</a> - Get the last error message</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function' rel='rdfs-seeAlso'>odbc_exec()</a> - Prepare and execute a SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_do" value="<div id='function.odbc-do' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-do.php'>odbc_do</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_do</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a></span></p> </div> <a name='function.odbc-do.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='para'> This function is an alias of: <a href='http://www.php.net/manual/en/function.odbc-exec.php' class='function'>odbc_exec()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_data_source" value="<div id='function.odbc-data-source' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-data-source.php'>odbc_data_source</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.0, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_data_source</span> &amp;mdash; <span class='dc-title'>Returns information about a current connection</span></p> </div> <a name='function.odbc-data-source.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>odbc_data_source</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$fetch_type</tt></span> )</div> <p class='para rdfs-comment'> This function will return the list of available DNS (after calling it several times). </p> </div> <a name='function.odbc-data-source.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>fetch_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>fetch_type</tt></i> can be one of two constant types: <b><tt class='constant'>SQL_FETCH_FIRST</tt></b>, <b><tt class='constant'>SQL_FETCH_NEXT</tt></b>. Use <b><tt class='constant'>SQL_FETCH_FIRST</tt></b> the first time this function is called, thereafter use the <b><tt class='constant'>SQL_FETCH_NEXT</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-data-source.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> on error, and an array upon success. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_cursor" value="<div id='function.odbc-cursor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-cursor.php'>odbc_cursor</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_cursor</span> &amp;mdash; <span class='dc-title'>Get cursorname</span></p> </div> <a name='function.odbc-cursor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>odbc_cursor</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Gets the cursorname for the given result_id. </p> </div> <a name='function.odbc-cursor.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-cursor.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the cursor name, as a string. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_connect" value="<div id='function.odbc-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-connect.php'>odbc_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_connect</span> &amp;mdash; <span class='dc-title'>Connect to a datasource</span></p> </div> <a name='function.odbc-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dsn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$user</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$cursor_type</tt></span> ] )</div> <p class='simpara'> The connection id returned by this functions is needed by other ODBC functions. You can have multiple connections open at once as long as they either use different db or different credentials. </p> <p class='simpara'> With some ODBC drivers, executing a complex stored procedure may fail with an error similar to: &amp;quot;Cannot open a cursor on a stored procedure that has anything other than a single select statement in it&amp;quot;. Using SQL_CUR_USE_ODBC may avoid that error. Also, some drivers don&amp;#039;t support the optional row_number parameter in <a href='http://www.php.net/manual/en/function.odbc-fetch-row.php' class='function'>odbc_fetch_row()</a>. SQL_CUR_USE_ODBC might help in that case, too. </p> </div> <a name='function.odbc-connect.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'>dsn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database source name for the connection. Alternatively, a DNS-less connection string can be used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>user</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cursor_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This sets the type of cursor to be used for this connection. This parameter is not normally needed, but can be useful for working around problems with some ODBC drivers. </p> <span class='simpara'> The following constants are defined for cursortype: </span> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> SQL_CUR_USE_IF_NEEDED </span> </li> <li class='listitem'> <span class='simpara'> SQL_CUR_USE_ODBC </span> </li> <li class='listitem'> <span class='simpara'> SQL_CUR_USE_DRIVER </span> </li> <li class='listitem'> <span class='simpara'> SQL_CUR_DEFAULT </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC connection id or 0 (<b><tt class='constant'>FALSE</tt></b>) on error. </p> </div> <a name='function.odbc-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 DNS-less connections</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Microsoft&amp;nbsp;SQL&amp;nbsp;Server&amp;nbsp;using&amp;nbsp;the&amp;nbsp;SQL&amp;nbsp;Native&amp;nbsp;Client&amp;nbsp;10.0&amp;nbsp;ODBC&amp;nbsp;Driver&amp;nbsp;-&amp;nbsp;allows&amp;nbsp;connection&amp;nbsp;to&amp;nbsp;SQL&amp;nbsp;7,&amp;nbsp;2000,&amp;nbsp;2005&amp;nbsp;and&amp;nbsp;2008<br /></span><span style='color: #0000BB'>$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Driver={SQL&amp;nbsp;Server&amp;nbsp;Native&amp;nbsp;Client&amp;nbsp;10.0};Server=</span><span style='color: #0000BB'>$server</span><span style='color: #DD0000'>;Database=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Microsoft&amp;nbsp;Access<br /></span><span style='color: #0000BB'>$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Driver={Microsoft&amp;nbsp;Access&amp;nbsp;Driver&amp;nbsp;(*.mdb)};Dbq=</span><span style='color: #0000BB'>$mdbFilename</span><span style='color: #DD0000'>'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Microsoft&amp;nbsp;Excel<br /></span><span style='color: #0000BB'>$excelFile&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>realpath</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'C:/ExcelData.xls'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$excelDir&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>dirname</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$excelFile</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>odbc_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Driver={Microsoft&amp;nbsp;Excel&amp;nbsp;Driver&amp;nbsp;(*.xls)};DriverId=790;Dbq=</span><span style='color: #0000BB'>$excelFile</span><span style='color: #DD0000'>;DefaultDir=</span><span style='color: #0000BB'>$excelDir</span><span style='color: #DD0000'>'&amp;nbsp;</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.odbc-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'>For persistent connections: <a href='http://www.php.net/manual/en/function.odbc-pconnect.php' class='function' rel='rdfs-seeAlso'>odbc_pconnect()</a> - Open a persistent database connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_commit" value="<div id='function.odbc-commit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-commit.php'>odbc_commit</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_commit</span> &amp;mdash; <span class='dc-title'>Commit an ODBC transaction</span></p> </div> <a name='function.odbc-commit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_commit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> )</div> <p class='para rdfs-comment'> Commits all pending transactions on the connection. </p> </div> <a name='function.odbc-commit.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> </dl> <p> </p> </div> <a name='function.odbc-commit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_columns" value="<div id='function.odbc-columns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-columns.php'>odbc_columns</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_columns</span> &amp;mdash; <span class='dc-title'>Lists the column names in specified tables</span></p> </div> <a name='function.odbc-columns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_columns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column_name</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Lists all columns in the requested range. </p> </div> <a name='function.odbc-columns.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The table name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The column name. </p> </dd> </dl> <p> </p> <p class='para'> The <i><tt class='parameter'>schema</tt></i> , <i><tt class='parameter'>table_name</tt></i> , and <i><tt class='parameter'>column_name</tt></i> accept search patterns (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character). </p> </div> <a name='function.odbc-columns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_SCHEM</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>COLUMN_NAME</span></li> <li class='listitem'><span class='simpara'>DATA_TYPE</span></li> <li class='listitem'><span class='simpara'>TYPE_NAME</span></li> <li class='listitem'><span class='simpara'>PRECISION</span></li> <li class='listitem'><span class='simpara'>LENGTH</span></li> <li class='listitem'><span class='simpara'>SCALE</span></li> <li class='listitem'><span class='simpara'>RADIX</span></li> <li class='listitem'><span class='simpara'>NULLABLE</span></li> <li class='listitem'><span class='simpara'>REMARKS</span></li> </ul><p> </p> <p class='para'> The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and TABLE_NAME. </p> </div> <a name='function.odbc-columns.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-columnprivileges.php' class='function' rel='rdfs-seeAlso'>odbc_columnprivileges()</a> - Lists columns and associated privileges for the given table to retrieve associated privileges</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_columnprivileges" value="<div id='function.odbc-columnprivileges' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-columnprivileges.php'>odbc_columnprivileges</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_columnprivileges</span> &amp;mdash; <span class='dc-title'>Lists columns and associated privileges for the given table</span></p> </div> <a name='function.odbc-columnprivileges.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>odbc_columnprivileges</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$owner</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column_name</tt></span> )</div> <p class='para rdfs-comment'> Lists columns and associated privileges for the given table. </p> </div> <a name='function.odbc-columnprivileges.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The qualifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>owner</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The owner. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The table name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>column_name</tt></i> argument accepts search patterns (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character). </p> </dd> </dl> <p> </p> <p class='para'> The <i><tt class='parameter'>owner</tt></i> , <i><tt class='parameter'>table_name</tt></i> , and <i><tt class='parameter'>column_name</tt></i> accept search patterns (&amp;#039;%&amp;#039; to match zero or more characters and &amp;#039;_&amp;#039; to match a single character). </p> </div> <a name='function.odbc-columnprivileges.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an ODBC result identifier or <b><tt class='constant'>FALSE</tt></b> on failure. This result identifier can be used to fetch a list of columns and associated privileges. </p> <p class='para'> The result set has the following columns: </p><ul class='itemizedlist'> <li class='listitem'><span class='simpara'>TABLE_QUALIFIER</span></li> <li class='listitem'><span class='simpara'>TABLE_OWNER</span></li> <li class='listitem'><span class='simpara'>TABLE_NAME</span></li> <li class='listitem'><span class='simpara'>GRANTOR</span></li> <li class='listitem'><span class='simpara'>GRANTEE</span></li> <li class='listitem'><span class='simpara'>PRIVILEGE</span></li> <li class='listitem'><span class='simpara'>IS_GRANTABLE</span></li> </ul><p> </p> <p class='para'> The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_close_all" value="<div id='function.odbc-close-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-close-all.php'>odbc_close_all</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_close_all</span> &amp;mdash; <span class='dc-title'>Close all ODBC connections</span></p> </div> <a name='function.odbc-close-all.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>odbc_close_all</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> <b>odbc_close_all()</b> will close down all connections to database server(s). </p> </div> <a name='function.odbc-close-all.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='function.odbc-close-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.odbc-close-all.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function will fail if there are open transactions on a connection. This connection will remain open in this case. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_close" value="<div id='function.odbc-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-close.php'>odbc_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_close</span> &amp;mdash; <span class='dc-title'>Close an ODBC connection</span></p> </div> <a name='function.odbc-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>odbc_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> )</div> <p class='para rdfs-comment'> Closes down the connection to the database server. </p> </div> <a name='function.odbc-close.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> </dl> <p> </p> </div> <a name='function.odbc-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.odbc-close.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function will fail if there are open transactions on this connection. The connection will remain open in this case. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_binmode" value="<div id='function.odbc-binmode' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-binmode.php'>odbc_binmode</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_binmode</span> &amp;mdash; <span class='dc-title'>Handling of binary column data</span></p> </div> <a name='function.odbc-binmode.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>odbc_binmode</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> )</div> <p class='para rdfs-comment'> Enables handling of binary column data. ODBC SQL types affected are <i>BINARY</i>, <i>VARBINARY</i>, and <i>LONGVARBINARY</i>. </p> <p class='para'> When binary SQL data is converted to character C data, each byte (8 bits) of source data is represented as two ASCII characters. These characters are the ASCII character representation of the number in its hexadecimal form. For example, a binary <i>00000001</i> is converted to <i>&amp;quot;01&amp;quot;</i> and a binary <i>11111111</i> is converted to <i>&amp;quot;FF&amp;quot;</i>. </p><table class='doctable table'> <caption><b>LONGVARBINARY handling</b></caption> <thead valign='middle'> <tr valign='middle'> <th>binmode</th> <th>longreadlen</th> <th>result</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_PASSTHRU</tt></b></td> <td align='left'>0</td> <td align='left'>passthru</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_RETURN</tt></b></td> <td align='left'>0</td> <td align='left'>passthru</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_CONVERT</tt></b></td> <td align='left'>0</td> <td align='left'>passthru</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_PASSTHRU</tt></b></td> <td align='left'>0</td> <td align='left'>passthru</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_PASSTHRU</tt></b></td> <td align='left'>&amp;gt;0</td> <td align='left'>passthru</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_RETURN</tt></b></td> <td align='left'>&amp;gt;0</td> <td align='left'>return as is</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>ODBC_BINMODE_CONVERT</tt></b></td> <td align='left'>&amp;gt;0</td> <td align='left'>return as char</td> </tr> </tbody> </table> <p> </p> <p class='para'> If <a href='http://www.php.net/manual/en/function.odbc-fetch-into.php' class='function'>odbc_fetch_into()</a> is used, passthru means that an empty string is returned for these columns. </p> </div> <a name='function.odbc-binmode.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_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result identifier. </p> <p class='para'> If <i><tt class='parameter'>result_id</tt></i> is <i>0</i>, the settings apply as default for new results. </p><blockquote><p><b class='note'>Note</b>: <span class='simpara'> Default for <i>longreadlen</i> is <i>4096</i> and <i><tt class='parameter'>mode</tt></i> defaults to <i>ODBC_BINMODE_RETURN</i>. Handling of binary long columns is also affected by <a href='http://www.php.net/manual/en/function.odbc-longreadlen.php' class='function'>odbc_longreadlen()</a>. </span> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Possible values for <i><tt class='parameter'>mode</tt></i> are: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>ODBC_BINMODE_PASSTHRU</tt></b>: Passthru BINARY data </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>ODBC_BINMODE_RETURN</tt></b>: Return as is </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>ODBC_BINMODE_CONVERT</tt></b>: Convert to char and return </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-binmode.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="odbc_autocommit" value="<div id='function.odbc-autocommit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.odbc-autocommit.php'>odbc_autocommit</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>odbc_autocommit</span> &amp;mdash; <span class='dc-title'>Toggle autocommit behaviour</span></p> </div> <a name='function.odbc-autocommit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>odbc_autocommit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection_id</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$OnOff</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Toggles autocommit behaviour. </p> <p class='para'> By default, auto-commit is on for a connection. Disabling auto-commit is equivalent with starting a transaction. </p> </div> <a name='function.odbc-autocommit.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'>connection_id</tt></i> </span> </dt><dd class='listitem'> <p class='para'>The ODBC connection identifier, see <a href='http://www.php.net/manual/en/function.odbc-connect.php' class='function'>odbc_connect()</a> for details.</p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>OnOff</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <i><tt class='parameter'>OnOff</tt></i> is <b><tt class='constant'>TRUE</tt></b>, auto-commit is enabled, if it is <b><tt class='constant'>FALSE</tt></b> auto-commit is disabled. </p> </dd> </dl> <p> </p> </div> <a name='function.odbc-autocommit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Without the <i><tt class='parameter'>OnOff</tt></i> parameter, this function returns auto-commit status for <i><tt class='parameter'>connection_id</tt></i> . Non-zero is returned if auto-commit is on, 0 if it is off, or <b><tt class='constant'>FALSE</tt></b> if an error occurs. </p> <p class='para'> If <i><tt class='parameter'>OnOff</tt></i> is set, this function returns <b><tt class='constant'>TRUE</tt></b> on success and <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.odbc-autocommit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-commit.php' class='function' rel='rdfs-seeAlso'>odbc_commit()</a> - Commit an ODBC transaction</li> <li class='member'><a href='http://www.php.net/manual/en/function.odbc-rollback.php' class='function' rel='rdfs-seeAlso'>odbc_rollback()</a> - Rollback a transaction</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociwritelobtofile" value="<div id='function.ociwritelobtofile' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociwritelobtofile.php'>ociwritelobtofile</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociwritelobtofile</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-lob-export.php' class='xref'>OCI-Lob->export</a></span></p> </div> <a name='function.ociwritelobtofile.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-lob-export.php' class='xref'>OCI-Lob->export</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocistatementtype" value="<div id='function.ocistatementtype' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocistatementtype.php'>ocistatementtype</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocistatementtype</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-statement-type.php' class='function'>oci_statement_type()</a></span></p> </div> <a name='function.ocistatementtype.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-statement-type.php' class='function'>oci_statement_type()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocisetprefetch" value="<div id='function.ocisetprefetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocisetprefetch.php'>ocisetprefetch</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocisetprefetch</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-set-prefetch.php' class='function'>oci_set_prefetch()</a></span></p> </div> <a name='function.ocisetprefetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-set-prefetch.php' class='function'>oci_set_prefetch()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociserverversion" value="<div id='function.ociserverversion' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociserverversion.php'>ociserverversion</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociserverversion</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-server-version.php' class='function'>oci_server_version()</a></span></p> </div> <a name='function.ociserverversion.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-server-version.php' class='function'>oci_server_version()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocisavelobfile" value="<div id='function.ocisavelobfile' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocisavelobfile.php'>ocisavelobfile</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocisavelobfile</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-lob-import.php' class='xref'>OCI-Lob->import</a></span></p> </div> <a name='function.ocisavelobfile.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-lob-import.php' class='xref'>OCI-Lob->import</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocisavelob" value="<div id='function.ocisavelob' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocisavelob.php'>ocisavelob</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocisavelob</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-lob-save.php' class='xref'>OCI-Lob->save</a></span></p> </div> <a name='function.ocisavelob.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-lob-save.php' class='xref'>OCI-Lob->save</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocirowcount" value="<div id='function.ocirowcount' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocirowcount.php'>ocirowcount</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocirowcount</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-num-rows.php' class='function'>oci_num_rows()</a></span></p> </div> <a name='function.ocirowcount.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-num-rows.php' class='function'>oci_num_rows()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocirollback" value="<div id='function.ocirollback' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocirollback.php'>ocirollback</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocirollback</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-rollback.php' class='function'>oci_rollback()</a></span></p> </div> <a name='function.ocirollback.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-rollback.php' class='function'>oci_rollback()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociresult" value="<div id='function.ociresult' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociresult.php'>ociresult</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociresult</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-result.php' class='function'>oci_result()</a></span></p> </div> <a name='function.ociresult.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-result.php' class='function'>oci_result()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociplogon" value="<div id='function.ociplogon' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociplogon.php'>ociplogon</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociplogon</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a></span></p> </div> <a name='function.ociplogon.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociparse" value="<div id='function.ociparse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociparse.php'>ociparse</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociparse</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-parse.php' class='function'>oci_parse()</a></span></p> </div> <a name='function.ociparse.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-parse.php' class='function'>oci_parse()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocinumcols" value="<div id='function.ocinumcols' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocinumcols.php'>ocinumcols</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocinumcols</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-num-fields.php' class='function'>oci_num_fields()</a></span></p> </div> <a name='function.ocinumcols.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-num-fields.php' class='function'>oci_num_fields()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocinlogon" value="<div id='function.ocinlogon' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocinlogon.php'>ocinlogon</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocinlogon</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function'>oci_new_connect()</a></span></p> </div> <a name='function.ocinlogon.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function'>oci_new_connect()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocinewdescriptor" value="<div id='function.ocinewdescriptor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocinewdescriptor.php'>ocinewdescriptor</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocinewdescriptor</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-new-descriptor.php' class='function'>oci_new_descriptor()</a></span></p> </div> <a name='function.ocinewdescriptor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-new-descriptor.php' class='function'>oci_new_descriptor()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocinewcursor" value="<div id='function.ocinewcursor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocinewcursor.php'>ocinewcursor</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocinewcursor</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-new-cursor.php' class='function'>oci_new_cursor()</a></span></p> </div> <a name='function.ocinewcursor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-new-cursor.php' class='function'>oci_new_cursor()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocinewcollection" value="<div id='function.ocinewcollection' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocinewcollection.php'>ocinewcollection</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocinewcollection</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-new-collection.php' class='function'>oci_new_collection()</a></span></p> </div> <a name='function.ocinewcollection.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-new-collection.php' class='function'>oci_new_collection()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocilogon" value="<div id='function.ocilogon' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocilogon.php'>ocilogon</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocilogon</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a></span></p> </div> <a name='function.ocilogon.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocilogoff" value="<div id='function.ocilogoff' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocilogoff.php'>ocilogoff</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocilogoff</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-close.php' class='function'>oci_close()</a></span></p> </div> <a name='function.ocilogoff.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-close.php' class='function'>oci_close()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociloadlob" value="<div id='function.ociloadlob' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociloadlob.php'>ociloadlob</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociloadlob</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-lob-load.php' class='xref'>OCI-Lob->load</a></span></p> </div> <a name='function.ociloadlob.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-lob-load.php' class='xref'>OCI-Lob->load</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociinternaldebug" value="<div id='function.ociinternaldebug' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociinternaldebug.php'>ociinternaldebug</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociinternaldebug</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-internal-debug.php' class='function'>oci_internal_debug()</a></span></p> </div> <a name='function.ociinternaldebug.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-internal-debug.php' class='function'>oci_internal_debug()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifreestatement" value="<div id='function.ocifreestatement' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifreestatement.php'>ocifreestatement</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifreestatement</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-free-statement.php' class='function'>oci_free_statement()</a></span></p> </div> <a name='function.ocifreestatement.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-free-statement.php' class='function'>oci_free_statement()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifreedesc" value="<div id='function.ocifreedesc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifreedesc.php'>ocifreedesc</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifreedesc</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-lob-free.php' class='xref'>OCI-Lob->free</a></span></p> </div> <a name='function.ocifreedesc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-lob-free.php' class='xref'>OCI-Lob->free</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifreecursor" value="<div id='function.ocifreecursor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifreecursor.php'>ocifreecursor</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifreecursor</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-free-statement.php' class='function'>oci_free_statement()</a></span></p> </div> <a name='function.ocifreecursor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-free-statement.php' class='function'>oci_free_statement()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifreecollection" value="<div id='function.ocifreecollection' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifreecollection.php'>ocifreecollection</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifreecollection</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-free.php' class='xref'>OCI-Collection->free</a></span></p> </div> <a name='function.ocifreecollection.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-free.php' class='xref'>OCI-Collection->free</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifetchstatement" value="<div id='function.ocifetchstatement' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifetchstatement.php'>ocifetchstatement</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifetchstatement</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function'>oci_fetch_all()</a></span></p> </div> <a name='function.ocifetchstatement.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function'>oci_fetch_all()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifetchinto" value="<div id='function.ocifetchinto' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifetchinto.php'>ocifetchinto</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifetchinto</span> &amp;mdash; <span class='dc-title'>Fetches the next row into an array (deprecated)</span></p> </div> <a name='function.ocifetchinto.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>ocifetchinto</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$result</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> ] )</div> <p class='para rdfs-comment'> This function is deprecated. Recommended alternatives: <a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function'>oci_fetch_array()</a>, <a href='http://www.php.net/manual/en/function.oci-fetch-object.php' class='function'>oci_fetch_object()</a>, <a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function'>oci_fetch_assoc()</a> and <a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function'>oci_fetch_row()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocifetch" value="<div id='function.ocifetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocifetch.php'>ocifetch</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocifetch</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-fetch.php' class='function'>oci_fetch()</a></span></p> </div> <a name='function.ocifetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-fetch.php' class='function'>oci_fetch()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ociexecute" value="<div id='function.ociexecute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ociexecute.php'>ociexecute</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ociexecute</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-execute.php' class='function'>oci_execute()</a></span></p> </div> <a name='function.ociexecute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-execute.php' class='function'>oci_execute()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocierror" value="<div id='function.ocierror' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocierror.php'>ocierror</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocierror</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-error.php' class='function'>oci_error()</a></span></p> </div> <a name='function.ocierror.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-error.php' class='function'>oci_error()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocidefinebyname" value="<div id='function.ocidefinebyname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocidefinebyname.php'>ocidefinebyname</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocidefinebyname</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-define-by-name.php' class='function'>oci_define_by_name()</a></span></p> </div> <a name='function.ocidefinebyname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-define-by-name.php' class='function'>oci_define_by_name()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicommit" value="<div id='function.ocicommit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicommit.php'>ocicommit</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicommit</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-commit.php' class='function'>oci_commit()</a></span></p> </div> <a name='function.ocicommit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-commit.php' class='function'>oci_commit()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumntyperaw" value="<div id='function.ocicolumntyperaw' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumntyperaw.php'>ocicolumntyperaw</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumntyperaw</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-type-raw.php' class='function'>oci_field_type_raw()</a></span></p> </div> <a name='function.ocicolumntyperaw.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-type-raw.php' class='function'>oci_field_type_raw()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumntype" value="<div id='function.ocicolumntype' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumntype.php'>ocicolumntype</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumntype</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function'>oci_field_type()</a></span></p> </div> <a name='function.ocicolumntype.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function'>oci_field_type()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumnsize" value="<div id='function.ocicolumnsize' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumnsize.php'>ocicolumnsize</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumnsize</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-size.php' class='function'>oci_field_size()</a></span></p> </div> <a name='function.ocicolumnsize.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-size.php' class='function'>oci_field_size()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumnscale" value="<div id='function.ocicolumnscale' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumnscale.php'>ocicolumnscale</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumnscale</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-scale.php' class='function'>oci_field_scale()</a></span></p> </div> <a name='function.ocicolumnscale.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-scale.php' class='function'>oci_field_scale()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumnprecision" value="<div id='function.ocicolumnprecision' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumnprecision.php'>ocicolumnprecision</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumnprecision</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-precision.php' class='function'>oci_field_precision()</a></span></p> </div> <a name='function.ocicolumnprecision.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-precision.php' class='function'>oci_field_precision()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumnname" value="<div id='function.ocicolumnname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumnname.php'>ocicolumnname</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumnname</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-name.php' class='function'>oci_field_name()</a></span></p> </div> <a name='function.ocicolumnname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-name.php' class='function'>oci_field_name()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolumnisnull" value="<div id='function.ocicolumnisnull' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolumnisnull.php'>ocicolumnisnull</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolumnisnull</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-field-is-null.php' class='function'>oci_field_is_null()</a></span></p> </div> <a name='function.ocicolumnisnull.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-field-is-null.php' class='function'>oci_field_is_null()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicolltrim" value="<div id='function.ocicolltrim' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicolltrim.php'>ocicolltrim</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicolltrim</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-trim.php' class='xref'>OCI-Collection->trim</a></span></p> </div> <a name='function.ocicolltrim.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-trim.php' class='xref'>OCI-Collection->trim</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicollsize" value="<div id='function.ocicollsize' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicollsize.php'>ocicollsize</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicollsize</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-size.php' class='xref'>OCI-Collection->size</a></span></p> </div> <a name='function.ocicollsize.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-size.php' class='xref'>OCI-Collection->size</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicollmax" value="<div id='function.ocicollmax' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicollmax.php'>ocicollmax</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicollmax</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-max.php' class='xref'>OCI-Collection->max</a></span></p> </div> <a name='function.ocicollmax.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-max.php' class='xref'>OCI-Collection->max</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicollgetelem" value="<div id='function.ocicollgetelem' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicollgetelem.php'>ocicollgetelem</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicollgetelem</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-element-get.php' class='xref'>OCI-Collection->getElem</a></span></p> </div> <a name='function.ocicollgetelem.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-element-get.php' class='xref'>OCI-Collection->getElem</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicollassignelem" value="<div id='function.ocicollassignelem' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicollassignelem.php'>ocicollassignelem</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicollassignelem</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-element-assign.php' class='xref'>OCI-Collection->assignElem</a></span></p> </div> <a name='function.ocicollassignelem.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-element-assign.php' class='xref'>OCI-Collection->assignElem</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicollappend" value="<div id='function.ocicollappend' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicollappend.php'>ocicollappend</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.6, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicollappend</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-collection-append.php' class='xref'>OCI-Collection->append</a></span></p> </div> <a name='function.ocicollappend.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-collection-append.php' class='xref'>OCI-Collection->append</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocicancel" value="<div id='function.ocicancel' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocicancel.php'>ocicancel</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocicancel</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-cancel.php' class='function'>oci_cancel()</a></span></p> </div> <a name='function.ocicancel.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-cancel.php' class='function'>oci_cancel()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ocibindbyname" value="<div id='function.ocibindbyname' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ocibindbyname.php'>ocibindbyname</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL oci8 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>ocibindbyname</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.oci-bind-by-name.php' class='function'>oci_bind_by_name()</a></span></p> </div> <a name='function.ocibindbyname.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.oci-bind-by-name.php' class='function'>oci_bind_by_name()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_statement_type" value="<div id='function.oci-statement-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-statement-type.php'>oci_statement_type</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_statement_type</span> &amp;mdash; <span class='dc-title'>Returns the type of an OCI statement</span></p> </div> <a name='function.oci-statement-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>oci_statement_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Returns the type of the provided OCI <i><tt class='parameter'>statement</tt></i> . </p> </div> <a name='function.oci-statement-type.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-statement-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the query type of<i><tt class='parameter'>statement</tt></i> as one of the following values: </p><ol type='1'> <li class='listitem'><span class='simpara'><i>SELECT</i></span></li> <li class='listitem'><span class='simpara'><i>UPDATE</i></span></li> <li class='listitem'><span class='simpara'><i>DELETE</i></span></li> <li class='listitem'><span class='simpara'><i>INSERT</i></span></li> <li class='listitem'><span class='simpara'><i>CREATE</i></span></li> <li class='listitem'><span class='simpara'><i>DROP</i></span></li> <li class='listitem'><span class='simpara'><i>ALTER</i></span></li> <li class='listitem'><span class='simpara'><i>BEGIN</i></span></li> <li class='listitem'><span class='simpara'><i>DECLARE</i></span></li> <li class='listitem'><span class='simpara'><i>CALL</i> (since PHP 5.2.1 and OCI8 1.2.3)</span></li> <li class='listitem'><span class='simpara'><i>UNKNOWN</i></span></li> </ol><p> Returns <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-statement-type.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_statement_type()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$sql&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'delete&amp;nbsp;from&amp;nbsp;emp&amp;nbsp;where&amp;nbsp;deptno&amp;nbsp;=&amp;nbsp;10'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>oci_statement_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #DD0000'>'DELETE'</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'You&amp;nbsp;are&amp;nbsp;not&amp;nbsp;allowed&amp;nbsp;to&amp;nbsp;delete&amp;nbsp;from&amp;nbsp;this&amp;nbsp;table&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-statement-type.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocistatementtype.php' class='function'>ocistatementtype()</a> instead. This name still can be used, it was left as alias of <b>oci_statement_type()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_set_prefetch" value="<div id='function.oci-set-prefetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-set-prefetch.php'>oci_set_prefetch</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_set_prefetch</span> &amp;mdash; <span class='dc-title'>Sets number of rows to be prefetched</span></p> </div> <a name='function.oci-set-prefetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_set_prefetch</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$rows</tt></span> )</div> <p class='para rdfs-comment'> Sets the number of rows to be prefetched after successful call to <a href='http://www.php.net/manual/en/function.oci-execute.php' class='function'>oci_execute()</a>. </p> </div> <a name='function.oci-set-prefetch.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rows</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-set-prefetch.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-set-prefetch.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocisetprefetch.php' class='function'>ocisetprefetch()</a> instead. This name still can be used, it was left as alias of <b>oci_set_prefetch()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-set-prefetch.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'> <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.default-prefetch' class='link'>oci8_.default_prefetch</a> ini option </li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_server_version" value="<div id='function.oci-server-version' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-server-version.php'>oci_server_version</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_server_version</span> &amp;mdash; <span class='dc-title'>Returns server version</span></p> </div> <a name='function.oci-server-version.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>oci_server_version</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Returns a string with version information of the Oracle server, which uses the provided <i><tt class='parameter'>connection</tt></i> . </p> </div> <a name='function.oci-server-version.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-server-version.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the version information as a string or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-server-version.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_server_version()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Server&amp;nbsp;Version:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>oci_server_version</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-server-version.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociserverversion.php' class='function'>ociserverversion()</a> instead. This name still can be used, it was left as alias of <b>oci_server_version()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_rollback" value="<div id='function.oci-rollback' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-rollback.php'>oci_rollback</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_rollback</span> &amp;mdash; <span class='dc-title'>Rolls back outstanding transaction</span></p> </div> <a name='function.oci-rollback.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_rollback</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Rolls back all outstanding statements for the Oracle <i><tt class='parameter'>connection</tt></i> . </p> </div> <a name='function.oci-rollback.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-rollback.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-rollback.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Transactions are automatically rolled back when you close the connection, or when the script ends, whichever is soonest. You need to explicitly call <a href='http://www.php.net/manual/en/function.oci-commit.php' class='function'>oci_commit()</a> to commit the transaction, or <b>oci_rollback()</b> to abort it. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocirollback.php' class='function'>ocirollback()</a> instead. This name still can be used, it was left as alias of <b>oci_rollback()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-rollback.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-commit.php' class='function' rel='rdfs-seeAlso'>oci_commit()</a> - Commits outstanding statements</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_result" value="<div id='function.oci-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-result.php'>oci_result</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_result</span> &amp;mdash; <span class='dc-title'>Returns field&amp;#039;s value from the fetched row</span></p> </div> <a name='function.oci-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>oci_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns the data from <i><tt class='parameter'>field</tt></i> in the current row, fetched by <a href='http://www.php.net/manual/en/function.oci-fetch.php' class='function'>oci_fetch()</a>. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-result.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be either use the column number (1-based) or the column name (in uppercase). </p> </dd> </dl> <p> </p> </div> <a name='function.oci-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns everything as strings except for abstract types (ROWIDs, LOBs and FILEs). Returns <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociresult.php' class='function'>ociresult()</a> instead. This name still can be used, it was left as alias of <b>oci_result()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function' rel='rdfs-seeAlso'>oci_fetch_array()</a> - Returns the next row from the result data as an associative or numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>oci_fetch_assoc()</a> - Returns the next row from the result data as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-object.php' class='function' rel='rdfs-seeAlso'>oci_fetch_object()</a> - Returns the next row from the result data as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function' rel='rdfs-seeAlso'>oci_fetch_row()</a> - Returns the next row from the result data as a numeric array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function' rel='rdfs-seeAlso'>oci_fetch_all()</a> - Fetches all rows of result data into an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_pconnect" value="<div id='function.oci-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-pconnect.php'>oci_pconnect</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_pconnect</span> &amp;mdash; <span class='dc-title'>Connect to an Oracle database using a persistent connection</span></p> </div> <a name='function.oci-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_pconnect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$db</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$session_mode</tt></span> ]]] )</div> <p class='para rdfs-comment'> Creates a persistent connection to an Oracle server and logs on. </p> <p class='para'> Persistent connections are cached and re-used between requests, resulting in reduced overhead on each page load; a typical PHP application will have a single persistent connection open against an Oracle server per Apache child process (or PHP FastCGI/CGI process). See the <a href='http://www.php.net/manual/en/features.persistent-connections.php' class='link'>Persistent Database Connections</a> section for more information. </p> </div> <a name='function.oci-pconnect.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'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Oracle user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password for <i><tt class='parameter'>username</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>db</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter can either contain the name of the local Oracle instance or the name of the entry in <var class='filename'>tnsnames.ora</var>. </p> <p class='para'> If the not specified, PHP uses environment variables <i>ORACLE_SID</i> and <i>TWO_TASK</i> to determine the name of local Oracle instance and location of <var class='filename'>tnsnames.ora</var> accordingly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Using Oracle server version 9.2 and greater, you can indicate <i><tt class='parameter'>charset</tt></i> by parameter, which will be used in the new connection. If you&amp;#039;re using Oracle server &amp;lt; 9.2, this parameter will be ignored and the <i>NLS_LANG</i> environment variable will be used instead. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>session_mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter is available since version 1.1 and accepts the following values: <b><tt class='constant'>OCI_DEFAULT</tt></b>, <b><tt class='constant'>OCI_SYSOPER</tt></b> and <b><tt class='constant'>OCI_SYSDBA</tt></b>. If either <b><tt class='constant'>OCI_SYSOPER</tt></b> or <b><tt class='constant'>OCI_SYSDBA</tt></b> were specified, this function will try to establish privileged connection using external credentials. Privileged connections are disabled by default. To enable them you need to set <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.privileged-connect' class='link'>oci8.privileged_connect</a> to <i>On</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a connection identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-pconnect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> Starting with version 1.1 of the oci8 extension, the lifetime and maximum amount of persistent Oracle connections can be tuned by setting the following configuration values: <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.persistent-timeout' class='link'>oci8.persistent_timeout</a>, <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.ping-interval' class='link'>oci8.ping_interval</a> and <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.max-persistent' class='link'>oci8.max_persistent</a>. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> If you&amp;#039;re using PHP with Oracle Instant Client, you can use easy connect naming method described here: <a href='http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306' class='link external'>&amp;raquo; http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</a>. Basically this means you can specify &amp;quot;//db_host[:port]/database_name&amp;quot; as database name. But if you want to use the old way of naming you <em class='emphasis'>must</em> set either <b><tt class='constant'>ORACLE_HOME</tt></b> or <b><tt class='constant'>TNS_ADMIN</tt></b>. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociplogon.php' class='function'>ociplogon()</a> instead. This name still can be used, it was left as alias of <b>oci_pconnect()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-pconnect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-connect.php' class='function' rel='rdfs-seeAlso'>oci_connect()</a> - Establishes a connection to the Oracle server</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function' rel='rdfs-seeAlso'>oci_new_connect()</a> - Establishes a new connection to the Oracle server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_password_change" value="<div id='function.oci-password-change' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-password-change.php'>oci_password_change</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_password_change</span> &amp;mdash; <span class='dc-title'>Changes password of Oracle&amp;#039;s user</span></p> </div> <a name='function.oci-password-change.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_password_change</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$old_password</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$new_password</tt></span> )</div> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_password_change</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dbname</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$old_password</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$new_password</tt></span> )</div> <p class='para rdfs-comment'> Changes password for user with <i><tt class='parameter'>username</tt></i> . </p> </div> <a name='function.oci-password-change.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Oracle user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>old_password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The old password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>new_password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new password to be set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dbname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-password-change.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-password-change.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> The second <b>oci_password_change()</b> syntax is available since version 1.1. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <b>ocipasswordchange()</b> instead. This name still can be used, it was left as alias of <b>oci_password_change()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_parse" value="<div id='function.oci-parse' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-parse.php'>oci_parse</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_parse</span> &amp;mdash; <span class='dc-title'>Prepares Oracle statement for execution</span></p> </div> <a name='function.oci-parse.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_parse</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> )</div> <p class='para rdfs-comment'> Prepares the <i><tt class='parameter'>query</tt></i> using <i><tt class='parameter'>connection</tt></i> and returns the statement identifier, which can be used with <a href='http://www.php.net/manual/en/function.oci-bind-by-name.php' class='function'>oci_bind_by_name()</a>, <a href='http://www.php.net/manual/en/function.oci-execute.php' class='function'>oci_execute()</a> and other functions. </p> </div> <a name='function.oci-parse.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The SQL query. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-parse.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement handler on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-parse.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function <em class='emphasis'>does not</em> validate <i><tt class='parameter'>query</tt></i> . The only way to find out if <i><tt class='parameter'>query</tt></i> is valid SQL or PL/SQL statement - is to execute it. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociparse.php' class='function'>ociparse()</a> instead. This name still can be used, it was left as alias of <b>oci_parse()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_num_rows" value="<div id='function.oci-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-num-rows.php'>oci_num_rows</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_num_rows</span> &amp;mdash; <span class='dc-title'>Returns number of rows affected during statement execution</span></p> </div> <a name='function.oci-num-rows.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>oci_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of rows affected during statement execution. </p> </div> <a name='function.oci-num-rows.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows affected as an integer, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_num_rows()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'create&amp;nbsp;table&amp;nbsp;emp2&amp;nbsp;as&amp;nbsp;select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;emp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>oci_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;rows&amp;nbsp;inserted.&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'delete&amp;nbsp;from&amp;nbsp;emp2'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>oci_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;rows&amp;nbsp;deleted.&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'drop&amp;nbsp;table&amp;nbsp;emp2'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-num-rows.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function <em class='emphasis'>does not</em> return number of rows selected! For SELECT statements this function will return the number of rows, that were fetched to the buffer with <b>oci_fetch*()</b> functions. <br /> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocirowcount.php' class='function'>ocirowcount()</a> instead. This name still can be used, it was left as alias of <b>oci_num_rows()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_num_fields" value="<div id='function.oci-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-num-fields.php'>oci_num_fields</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_num_fields</span> &amp;mdash; <span class='dc-title'>Returns the number of result columns in a statement</span></p> </div> <a name='function.oci-num-fields.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>oci_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Gets the number of columns in the given <i><tt class='parameter'>statement</tt></i> . </p> </div> <a name='function.oci-num-fields.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of columns as an integer, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-num-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_num_fields()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;emp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>oci_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ncols&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>$ncols</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_name&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$column_name&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>':&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$column_value&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-num-fields.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocinumcols.php' class='function'>ocinumcols()</a> instead. This name still can be used, it was left as alias of <b>oci_num_fields()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_new_descriptor" value="<div id='function.oci-new-descriptor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-new-descriptor.php'>oci_new_descriptor</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_new_descriptor</span> &amp;mdash; <span class='dc-title'>Initializes a new empty LOB or FILE descriptor</span></p> </div> <a name='function.oci-new-descriptor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <span class='methodname'><b>oci_new_descriptor</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt><span class='initializer'> = OCI_DTYPE_LOB</span></span> ] )</div> <p class='para rdfs-comment'> Allocates resources to hold descriptor or LOB locator. </p> </div> <a name='function.oci-new-descriptor.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Valid values for <i><tt class='parameter'>type</tt></i> are: <b><tt class='constant'>OCI_DTYPE_FILE</tt></b>, <b><tt class='constant'>OCI_DTYPE_LOB</tt></b> and <b><tt class='constant'>OCI_DTYPE_ROWID</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-new-descriptor.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new LOB or FILE descriptor on success, <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-new-descriptor.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_new_descriptor()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;script&amp;nbsp;is&amp;nbsp;designed&amp;nbsp;to&amp;nbsp;be&amp;nbsp;called&amp;nbsp;from&amp;nbsp;a&amp;nbsp;HTML&amp;nbsp;form.<br />&amp;nbsp;*&amp;nbsp;It&amp;nbsp;expects&amp;nbsp;$user,&amp;nbsp;$password,&amp;nbsp;$table,&amp;nbsp;$where,&amp;nbsp;and&amp;nbsp;$commitsize<br />&amp;nbsp;*&amp;nbsp;to&amp;nbsp;be&amp;nbsp;passed&amp;nbsp;in&amp;nbsp;from&amp;nbsp;the&amp;nbsp;form.&amp;nbsp;&amp;nbsp;The&amp;nbsp;script&amp;nbsp;then&amp;nbsp;deletes<br />&amp;nbsp;*&amp;nbsp;the&amp;nbsp;selected&amp;nbsp;rows&amp;nbsp;using&amp;nbsp;the&amp;nbsp;ROWID&amp;nbsp;and&amp;nbsp;commits&amp;nbsp;after&amp;nbsp;each<br />&amp;nbsp;*&amp;nbsp;set&amp;nbsp;of&amp;nbsp;$commitsize&amp;nbsp;rows.&amp;nbsp;(Use&amp;nbsp;with&amp;nbsp;care,&amp;nbsp;there&amp;nbsp;is&amp;nbsp;no&amp;nbsp;rollback)<br />&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;rowid&amp;nbsp;from&amp;nbsp;</span><span style='color: #0000BB'>$table</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #0000BB'>$where</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rowid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_descriptor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_D_ROWID</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_define_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ROWID'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rowid</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />while&amp;nbsp;(</span><span style='color: #0000BB'>oci_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$nrows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$delete&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'delete&amp;nbsp;from&amp;nbsp;</span><span style='color: #0000BB'>$table</span><span style='color: #DD0000'>&amp;nbsp;where&amp;nbsp;ROWID&amp;nbsp;=&amp;nbsp;:rid'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$delete</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':rid'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rowid</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_ROWID</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$delete</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$nrows</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;((</span><span style='color: #0000BB'>$nrows&amp;nbsp;</span><span style='color: #007700'>%&amp;nbsp;</span><span style='color: #0000BB'>$commitsize</span><span style='color: #007700'>)&amp;nbsp;==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>$nrows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$nrows</span><span style='color: #DD0000'>&amp;nbsp;deleted...\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;This&amp;nbsp;script&amp;nbsp;demonstrates&amp;nbsp;file&amp;nbsp;upload&amp;nbsp;to&amp;nbsp;LOB&amp;nbsp;columns<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*&amp;nbsp;The&amp;nbsp;formfield&amp;nbsp;used&amp;nbsp;for&amp;nbsp;this&amp;nbsp;example&amp;nbsp;looks&amp;nbsp;like&amp;nbsp;this<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*&amp;nbsp;&amp;lt;form&amp;nbsp;action='upload.php'&amp;nbsp;method='post'&amp;nbsp;enctype='multipart/form-data'&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*&amp;nbsp;&amp;lt;input&amp;nbsp;type='file'&amp;nbsp;name='lob_upload'&amp;nbsp;/&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*&amp;nbsp;...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(!isset(</span><span style='color: #0000BB'>$lob_upload</span><span style='color: #007700'>)&amp;nbsp;||&amp;nbsp;</span><span style='color: #0000BB'>$lob_upload&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #DD0000'>'none'</span><span style='color: #007700'>){<br /></span><span style='color: #0000BB'>?&amp;gt;<br /></span>&amp;lt;form&amp;nbsp;action='upload.php'&amp;nbsp;method='post'&amp;nbsp;enctype='multipart/form-data'&amp;gt;<br />Upload&amp;nbsp;file:&amp;nbsp;&amp;lt;input&amp;nbsp;type='file'&amp;nbsp;name='lob_upload'&amp;nbsp;/&amp;gt;&amp;lt;br&amp;nbsp;/&amp;gt;<br />&amp;lt;input&amp;nbsp;type='submit'&amp;nbsp;value='Upload'&amp;nbsp;/&amp;gt;&amp;nbsp;-&amp;nbsp;&amp;lt;input&amp;nbsp;type='reset'&amp;nbsp;value='Reset'&amp;nbsp;/&amp;gt;<br />&amp;lt;/form&amp;gt;<br /><span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>}&amp;nbsp;else&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;$lob_upload&amp;nbsp;contains&amp;nbsp;the&amp;nbsp;temporary&amp;nbsp;filename&amp;nbsp;of&amp;nbsp;the&amp;nbsp;uploaded&amp;nbsp;file<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;see&amp;nbsp;also&amp;nbsp;the&amp;nbsp;features&amp;nbsp;section&amp;nbsp;on&amp;nbsp;file&amp;nbsp;upload,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;if&amp;nbsp;you&amp;nbsp;would&amp;nbsp;like&amp;nbsp;to&amp;nbsp;use&amp;nbsp;secure&amp;nbsp;uploads<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$lob&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_descriptor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_D_LOB</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'insert&amp;nbsp;into&amp;nbsp;</span><span style='color: #0000BB'>$table</span><span style='color: #DD0000'>&amp;nbsp;(id,&amp;nbsp;the_blob)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;values(my_seq.NEXTVAL,&amp;nbsp;EMPTY_BLOB())&amp;nbsp;returning&amp;nbsp;the_blob&amp;nbsp;into&amp;nbsp;:the_blob'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':the_blob'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$lob</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_BLOB</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$lob</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>savefile</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$lob_upload</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Blob&amp;nbsp;successfully&amp;nbsp;uploaded\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}else{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Couldn't&amp;nbsp;upload&amp;nbsp;Blob\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_free_descriptor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$lob</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 <b>oci_new_descriptor()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Calling&amp;nbsp;PL/SQL&amp;nbsp;stored&amp;nbsp;procedures&amp;nbsp;which&amp;nbsp;contain&amp;nbsp;clobs&amp;nbsp;as&amp;nbsp;input<br />&amp;nbsp;*&amp;nbsp;parameters&amp;nbsp;(PHP&amp;nbsp;4&amp;nbsp;&amp;gt;=&amp;nbsp;4.0.6).<br />&amp;nbsp;*&amp;nbsp;Example&amp;nbsp;PL/SQL&amp;nbsp;stored&amp;nbsp;procedure&amp;nbsp;signature&amp;nbsp;is:<br />&amp;nbsp;*<br />&amp;nbsp;*&amp;nbsp;PROCEDURE&amp;nbsp;save_data<br />&amp;nbsp;*&amp;nbsp;&amp;nbsp;&amp;nbsp;Argument&amp;nbsp;Name&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;Type&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;In/Out&amp;nbsp;Default?<br />&amp;nbsp;*&amp;nbsp;&amp;nbsp;&amp;nbsp;------------------------------&amp;nbsp;-----------------------&amp;nbsp;------&amp;nbsp;--------<br />&amp;nbsp;*&amp;nbsp;&amp;nbsp;&amp;nbsp;KEY&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;NUMBER(38)&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IN<br />&amp;nbsp;*&amp;nbsp;&amp;nbsp;&amp;nbsp;DATA&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;CLOB&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IN<br />&amp;nbsp;*<br />&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin&amp;nbsp;save_data(:key,&amp;nbsp;:data);&amp;nbsp;end;'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$clob&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_descriptor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_D_LOB</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':key'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$key</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':data'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$clob</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_CLOB</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$clob</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>write</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$clob</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>free</span><span style='color: #007700'>();<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-new-descriptor.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocinewdescriptor.php' class='function'>ocinewdescriptor()</a> instead. This name still can be used, it was left as alias of <b>oci_new_descriptor()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_new_cursor" value="<div id='function.oci-new-cursor' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-new-cursor.php'>oci_new_cursor</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_new_cursor</span> &amp;mdash; <span class='dc-title'>Allocates and returns a new cursor (statement handle)</span></p> </div> <a name='function.oci-new-cursor.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_new_cursor</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Allocates a new statement handle on the specified connection. </p> </div> <a name='function.oci-new-cursor.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-new-cursor.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new statement handle, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-new-cursor.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using REF CURSOR in an Oracle&amp;#039;s stored procedure</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;suppose&amp;nbsp;your&amp;nbsp;stored&amp;nbsp;procedure&amp;nbsp;info.output&amp;nbsp;returns&amp;nbsp;a&amp;nbsp;ref&amp;nbsp;cursor&amp;nbsp;in&amp;nbsp;:data<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$curs&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_cursor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'begin&amp;nbsp;info.output(:data);&amp;nbsp;end;'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'data'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$curs</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_CURSOR</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$curs</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$curs</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$curs</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Using REF CURSOR in an Oracle&amp;#039;s select statement</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;html&amp;gt;&amp;lt;body&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$count_cursor&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CURSOR(select&amp;nbsp;count(empno)&amp;nbsp;num_emps&amp;nbsp;from&amp;nbsp;emp&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'where&amp;nbsp;emp.deptno&amp;nbsp;=&amp;nbsp;dept.deptno)&amp;nbsp;as&amp;nbsp;EMPCNT&amp;nbsp;from&amp;nbsp;dept'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;deptno,dname,</span><span style='color: #0000BB'>$count_cursor</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border=\'1\'&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;DEPT&amp;nbsp;NAME&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;DEPT&amp;nbsp;#&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;#&amp;nbsp;EMPLOYEES&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dname&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'DNAME'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$deptno&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'DEPTNO'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$dname</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$deptno</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'EMPCNT'</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$subdata&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'EMPCNT'</span><span style='color: #007700'>]))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$num_emps&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$subdata</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NUM_EMPS'</span><span style='color: #007700'>];<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$num_emps</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/body&amp;gt;&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-new-cursor.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocinewcursor.php' class='function'>ocinewcursor()</a> instead. This name still can be used, it was left as alias of <b>oci_new_cursor()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_new_connect" value="<div id='function.oci-new-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-new-connect.php'>oci_new_connect</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_new_connect</span> &amp;mdash; <span class='dc-title'>Establishes a new connection to the Oracle server</span></p> </div> <a name='function.oci-new-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_new_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$db</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$session_mode</tt></span> ]]] )</div> <p class='para rdfs-comment'> Establishes a new connection to an Oracle server and logs on. </p> <p class='para'> Unlike <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> and <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>, <b>oci_new_connect()</b> does not cache connections and will always return a brand-new freshly opened connection handle. This is useful if your application needs transactional isolation between two sets of queries. </p> </div> <a name='function.oci-new-connect.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'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Oracle user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password for <i><tt class='parameter'>username</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>db</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter can either contain the name of the local Oracle instance or the name of the entry in <var class='filename'>tnsnames.ora</var>. </p> <p class='para'> If the not specified, PHP uses environment variables <i>ORACLE_SID</i> and <i>TWO_TASK</i> to determine the name of local Oracle instance and location of <var class='filename'>tnsnames.ora</var> accordingly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Using Oracle server version 9.2 and greater, you can indicate <i><tt class='parameter'>charset</tt></i> by parameter, which will be used in the new connection. If you&amp;#039;re using Oracle server &amp;lt; 9.2, this parameter will be ignored and the <i>NLS_LANG</i> environment variable will be used instead. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>session_mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter is available since version 1.1 and accepts the following values: <b><tt class='constant'>OCI_DEFAULT</tt></b>, <b><tt class='constant'>OCI_SYSOPER</tt></b> and <b><tt class='constant'>OCI_SYSDBA</tt></b>. If either <b><tt class='constant'>OCI_SYSOPER</tt></b> or <b><tt class='constant'>OCI_SYSDBA</tt></b> were specified, this function will try to establish privileged connection using external credentials. Privileged connections are disabled by default. To enable them you need to set <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.privileged-connect' class='link'>oci8.privileged_connect</a> to <i>On</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-new-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a connection identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-new-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> The following demonstrates how you can separate connections. </p><div class='example'> <p><b>Example #1 <b>oci_new_connect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;html&amp;gt;&amp;lt;pre&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$c1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$c2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>create_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'create&amp;nbsp;table&amp;nbsp;scott.hallo&amp;nbsp;(test<br />varchar2(64))'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;created&amp;nbsp;table\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>drop_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'drop&amp;nbsp;table&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;dropped&amp;nbsp;table\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'insert&amp;nbsp;into&amp;nbsp;scott.hallo<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;values('</span><span style='color: #0000BB'>$conn</span><span style='color: #DD0000'>'&amp;nbsp;||&amp;nbsp;'&amp;nbsp;'&amp;nbsp;||&amp;nbsp;to_char(sysdate,'DD-MON-YY&amp;nbsp;HH24:MI:SS'))'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;inserted&amp;nbsp;hallo\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>delete_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'delete&amp;nbsp;from&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;deleted&amp;nbsp;hallo\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;committed\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;rollback\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'----selecting\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>oci_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;lt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>oci_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'TEST'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;gt;\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'----done\n\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>create_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>delete_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>drop_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/pre&amp;gt;&amp;lt;/html&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-new-connect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> If you&amp;#039;re using PHP with Oracle Instant Client, you can use easy connect naming method described here: <a href='http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306' class='link external'>&amp;raquo; http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</a>. Basically this means you can specify &amp;quot;//db_host[:port]/database_name&amp;quot; as database name. But if you want to use the old way of naming you <em class='emphasis'>must</em> set either <b><tt class='constant'>ORACLE_HOME</tt></b> or <b><tt class='constant'>TNS_ADMIN</tt></b>. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocinlogon.php' class='function'>ocinlogon()</a> instead. This name still can be used, it was left as alias of <b>oci_new_connect()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-new-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-connect.php' class='function' rel='rdfs-seeAlso'>oci_connect()</a> - Establishes a connection to the Oracle server</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function' rel='rdfs-seeAlso'>oci_pconnect()</a> - Connect to an Oracle database using a persistent connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_new_collection" value="<div id='function.oci-new-collection' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-new-collection.php'>oci_new_collection</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_new_collection</span> &amp;mdash; <span class='dc-title'>Allocates new collection object</span></p> </div> <a name='function.oci-new-collection.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type OCI-Collection'>OCI-Collection</span></span> <span class='methodname'><b>oci_new_collection</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$tdo</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt><span class='initializer'> = NULL</span></span> ] )</div> <p class='para rdfs-comment'> Allocates a new collection object. </p> </div> <a name='function.oci-new-collection.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>tdo</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should be a valid named type (uppercase). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should point to the scheme, where the named type was created. The name of the current user is the default value. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-new-collection.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new <b class='classname'>OCICollection</b> object or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-new-collection.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocinewcollection.php' class='function'>ocinewcollection()</a> instead. This name still can be used, it was left as alias of <b>oci_new_collection()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_write" value="<div id='function.oci-lob-write' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-write.php'>OCI-Lob-&amp;gt;write</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;write</span> &amp;mdash; <span class='dc-title'>Writes data to the large object</span></p> </div> <a name='function.oci-lob-write.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>write</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> ] )</div> </div> <p class='para'> Writes data from the parameter <i><tt class='parameter'>data</tt></i> into the current position of LOB&amp;#039;s internal pointer. </p> </div> <a name='function.oci-lob-write.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'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to write in the LOB. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If this parameter is given, writing will stop after <i><tt class='parameter'>length</tt></i> bytes have been written or the end of <i><tt class='parameter'>data</tt></i> is reached, whichever comes first. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-write.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of bytes written or <b><tt class='constant'>FALSE</tt></b> in case of error. </p> </div> <a name='function.oci-lob-write.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-read.php' class='xref'>OCI-Lob->read</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_truncate" value="<div id='function.oci-lob-truncate' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-truncate.php'>OCI-Lob-&amp;gt;truncate</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;truncate</span> &amp;mdash; <span class='dc-title'>Truncates large object</span></p> </div> <a name='function.oci-lob-truncate.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>truncate</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> ] )</div> </div> <p class='para'> Truncates the LOB. </p> </div> <a name='function.oci-lob-truncate.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'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If provided, this method will truncate the LOB to <i><tt class='parameter'>length</tt></i> bytes. Otherwise, it will completrely purge the LOB. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-truncate.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-truncate.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-erase.php' class='xref'>OCI-Lob->erase</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_tell" value="<div id='function.oci-lob-tell' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-tell.php'>OCI-Lob-&amp;gt;tell</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;tell</span> &amp;mdash; <span class='dc-title'>Returns current position of internal pointer of large object</span></p> </div> <a name='function.oci-lob-tell.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>tell</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Gets the current position of a LOB&amp;#039;s internal pointer. </p> </div> <a name='function.oci-lob-tell.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns current position of a LOB&amp;#039;s internal pointer or <b><tt class='constant'>FALSE</tt></b> if an error occurred. </p> </div> <a name='function.oci-lob-tell.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-rewind.php' class='xref'>OCI-Lob->rewind</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-size.php' class='xref'>OCI-Lob->size</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-eof.php' class='xref'>OCI-Lob->eof</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_size" value="<div id='function.oci-lob-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-size.php'>OCI-Lob-&amp;gt;size</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;size</span> &amp;mdash; <span class='dc-title'>Returns size of large object</span></p> </div> <a name='function.oci-lob-size.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>size</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Gets the size of the large object. </p> </div> <a name='function.oci-lob-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns length of large object value or <b><tt class='constant'>FALSE</tt></b> in case of error. Empty objects have zero length. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_seek" value="<div id='function.oci-lob-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-seek.php'>OCI-Lob-&amp;gt;seek</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;seek</span> &amp;mdash; <span class='dc-title'>Sets the internal pointer of the large object</span></p> </div> <a name='function.oci-lob-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>seek</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$whence</tt></span> ] )</div> </div> <p class='para'> Sets the internal pointer of the large object. </p> </div> <a name='function.oci-lob-seek.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'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates the amount of bytes, on which internal pointer should be moved from the position, pointed by <i><tt class='parameter'>whence</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>whence</tt></i> </span> </dt><dd class='listitem'> <p class='para'> May be one of: </p><ul class='simplelist'> <li class='member'> <b><tt class='constant'>OCI_SEEK_SET</tt></b> - sets the position equal to <i><tt class='parameter'>offset</tt></i> </li> <li class='member'> <b><tt class='constant'>OCI_SEEK_CUR</tt></b> - adds <i><tt class='parameter'>offset</tt></i> bytes to the current position </li> <li class='member'> <b><tt class='constant'>OCI_SEEK_END</tt></b> - adds <i><tt class='parameter'>offset</tt></i> bytes to the end of large object (use negative value to move to a position before the end of large object) </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-seek.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-rewind.php' class='xref'>OCI-Lob->rewind</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-tell.php' class='xref'>OCI-Lob->tell</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-eof.php' class='xref'>OCI-Lob->eof</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_save" value="<div id='function.oci-lob-save' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-save.php'>OCI-Lob-&amp;gt;save</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;save</span> &amp;mdash; <span class='dc-title'>Saves data to the large object</span></p> </div> <a name='function.oci-lob-save.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>save</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$data</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> ] )</div> </div> <p class='para'> Saves <i><tt class='parameter'>data</tt></i> to the large object. </p> </div> <a name='function.oci-lob-save.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'>data</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The data to be saved. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be used to indicate offset from the beginning of the large object. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-save.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-save.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-write.php' class='xref'>OCI-Lob->write</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-import.php' class='xref'>OCI-Lob->import</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_rewind" value="<div id='function.oci-lob-rewind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-rewind.php'>OCI-Lob-&amp;gt;rewind</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;rewind</span> &amp;mdash; <span class='dc-title'>Moves the internal pointer to the beginning of the large object</span></p> </div> <a name='function.oci-lob-rewind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.rewind.php' class='function'>rewind</a></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Sets the internal pointer to the beginning of the large object. </p> </div> <a name='function.oci-lob-rewind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-rewind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-seek.php' class='xref'>OCI-Lob->seek</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-tell.php' class='xref'>OCI-Lob->tell</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_read" value="<div id='function.oci-lob-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-read.php'>OCI-Lob-&amp;gt;read</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;read</span> &amp;mdash; <span class='dc-title'>Reads part of the large object</span></p> </div> <a name='function.oci-lob-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>read</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> )</div> </div> <p class='para'> Reads <i><tt class='parameter'>length</tt></i> bytes from the current position of LOB&amp;#039;s internal pointer. </p> <p class='para'> Reading stops when <i><tt class='parameter'>length</tt></i> bytes have been read or end of the large object is reached. Internal pointer of the large object will be shifted on the amount of bytes read. </p> </div> <a name='function.oci-lob-read.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'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The length of data to read, in bytes. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the contents as a string, or <b><tt class='constant'>FALSE</tt></b> in case of error. </p> </div> <a name='function.oci-lob-read.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-load.php' class='xref'>OCI-Lob->load</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-write.php' class='xref'>OCI-Lob->write</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_load" value="<div id='function.oci-lob-load' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-load.php'>OCI-Lob-&amp;gt;load</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;load</span> &amp;mdash; <span class='dc-title'>Returns large object&amp;#039;s contents</span></p> </div> <a name='function.oci-lob-load.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>load</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Returns large object&amp;#039;s contents. As script execution is terminated when the <a href='http://www.php.net/manual/en/ini.core.php#ini.memory-limit' class='link'>memory_limit</a> is reached, ensure that the LOB does not exceed this limit. In most cases it&amp;#039;s recommended to use <a href='http://www.php.net/manual/en/function.oci-lob-read.php' class='xref'>OCI-Lob->read</a> instead. </p> </div> <a name='function.oci-lob-load.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the contents of the object, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-lob-load.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-read.php' class='xref'>OCI-Lob->read</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_is_equal" value="<div id='function.oci-lob-is-equal' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-is-equal.php'>oci_lob_is_equal</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_lob_is_equal</span> &amp;mdash; <span class='dc-title'>Compares two LOB/FILE locators for equality</span></p> </div> <a name='function.oci-lob-is-equal.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_lob_is_equal</b></span> ( <span class='methodparam'><span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <tt class='parameter'>$lob1</tt></span> , <span class='methodparam'><span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <tt class='parameter'>$lob2</tt></span> )</div> <p class='para rdfs-comment'> Compares two LOB/FILE locators. </p> </div> <a name='function.oci-lob-is-equal.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'>lob1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A LOB identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>lob2</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A LOB identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-is-equal.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if these objects are equal, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_import" value="<div id='function.oci-lob-import' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-import.php'>OCI-Lob-&amp;gt;import</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;import</span> &amp;mdash; <span class='dc-title'>Imports file data to the LOB</span></p> </div> <a name='function.oci-lob-import.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>import</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> )</div> </div> <p class='para'> Writes data from the <i><tt class='parameter'>filename</tt></i> in to the current position of large object. </p> </div> <a name='function.oci-lob-import.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'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to the file. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-import.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-import.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-export.php' class='xref'>OCI-Lob->export</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-write.php' class='xref'>OCI-Lob->write</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_flush" value="<div id='function.oci-lob-flush' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-flush.php'>OCI-Lob-&amp;gt;flush</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;flush</span> &amp;mdash; <span class='dc-title'>Flushes/writes buffer of the LOB to the server</span></p> </div> <a name='function.oci-lob-flush.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.flush.php' class='function'>flush</a></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flag</tt></span> ] )</div> </div> <p class='para'> <b>OCI-Lob->flush()</b> actually writes data to the server. </p> </div> <a name='function.oci-lob-flush.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'>flag</tt></i> </span> </dt><dd class='listitem'> <p class='para'> By default, resources are not freed, but using flag <b><tt class='constant'>OCI_LOB_BUFFER_FREE</tt></b> you can do it explicitly. Be sure you know what you&amp;#039;re doing - next read/write operation to the same part of LOB will involve a round-trip to the server and initialize new buffer resources. It is recommended to use <b><tt class='constant'>OCI_LOB_BUFFER_FREE</tt></b> flag only when you are not going to work with the LOB anymore. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-flush.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> if buffering was not enabled or an error occurred. </p> </div> <a name='function.oci-lob-flush.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-getbuffering.php' class='xref'>OCI-Lob->getBuffering</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-setbuffering.php' class='xref'>OCI-Lob->setBuffering</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_export" value="<div id='function.oci-lob-export' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-export.php'>OCI-Lob-&amp;gt;export</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;export</span> &amp;mdash; <span class='dc-title'>Exports LOB&amp;#039;s contents to a file</span></p> </div> <a name='function.oci-lob-export.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>export</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filename</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$start</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> ]] )</div> </div> <p class='para'> Exports LOB contents to a file. </p> </div> <a name='function.oci-lob-export.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'>filename</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Path to the file. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>start</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates from where to start exporting. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates the length of data to be exported. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-export.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-export.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-import.php' class='xref'>OCI-Lob->import</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_erase" value="<div id='function.oci-lob-erase' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-erase.php'>OCI-Lob-&amp;gt;erase</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;erase</span> &amp;mdash; <span class='dc-title'>Erases a specified portion of the internal LOB data</span></p> </div> <a name='function.oci-lob-erase.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>erase</b></span> ([ <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$offset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> ]] )</div> </div> <p class='para'> Erases a specified portion of the internal LOB data starting at a specified <i><tt class='parameter'>offset</tt></i> . If called without parameters, it erases all LOB data. </p> <p class='para'> For BLOBs, erasing means that the existing LOB value is overwritten with zero-bytes. For CLOBs, the existing LOB value is overwritten with spaces. </p> </div> <a name='function.oci-lob-erase.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'>offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-erase.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the actual number of characters/bytes erased or <b><tt class='constant'>FALSE</tt></b> in case of error. </p> </div> <a name='function.oci-lob-erase.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-truncate.php' class='xref'>OCI-Lob->truncate</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_eof" value="<div id='function.oci-lob-eof' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-eof.php'>OCI-Lob-&amp;gt;eof</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;eof</span> &amp;mdash; <span class='dc-title'>Tests for end-of-file on a large object&amp;#039;s descriptor</span></p> </div> <a name='function.oci-lob-eof.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>eof</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Tells whether the internal pointer of large object is at the end of LOB. </p> </div> <a name='function.oci-lob-eof.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if internal pointer of large object is at the end of LOB. Otherwise returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.oci-lob-eof.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-size.php' class='xref'>OCI-Lob->size</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_copy" value="<div id='function.oci-lob-copy' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-copy.php'>oci_lob_copy</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_lob_copy</span> &amp;mdash; <span class='dc-title'>Copies large object</span></p> </div> <a name='function.oci-lob-copy.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_lob_copy</b></span> ( <span class='methodparam'><span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <tt class='parameter'>$lob_to</tt></span> , <span class='methodparam'><span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <tt class='parameter'>$lob_from</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt><span class='initializer'> = 0</span></span> ] )</div> <p class='para rdfs-comment'> Copies a large object or a part of a large object to another large object. Old LOB-recipient data will be overwritten. </p> <p class='para'> If you need to copy a particular part of a LOB to a particular position of a LOB, use <a href='http://www.php.net/manual/en/function.oci-lob-seek.php' class='function'>oci_lob_seek()</a> to move LOB internal pointers. </p> </div> <a name='function.oci-lob-copy.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'>lob_to</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The destination LOB. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>lob_from</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The copied LOB. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Indicates the length of data to be copied. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-copy.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_lob_append" value="<div id='function.oci-lob-append' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-lob-append.php'>OCI-Lob-&amp;gt;append</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Lob-&amp;gt;append</span> &amp;mdash; <span class='dc-title'>Appends data from the large object to another large object</span></p> </div> <a name='function.oci-lob-append.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Lob</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>append</b></span> ( <span class='methodparam'><span class='type'><span class='type OCI-Lob'>OCI-Lob</span></span> <tt class='parameter'>$lob_from</tt></span> )</div> </div> <p class='para'> Appends data from the large object to the end of another large object. </p> <p class='para'> Writing to the large object with this method will fail if buffering was previously enabled. You must disable buffering before appending. You may need to flush buffers with <a href='http://www.php.net/manual/en/function.oci-lob-flush.php' class='xref'>OCI-Lob->flush</a> before disabling buffering. </p> </div> <a name='function.oci-lob-append.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'>lob_from</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The copied LOB. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-lob-append.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-lob-append.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-flush.php' class='xref'>OCI-Lob->flush</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-setbuffering.php' class='xref'>OCI-Lob->setBuffering</a></li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-lob-getbuffering.php' class='xref'>OCI-Lob->getBuffering</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_internal_debug" value="<div id='function.oci-internal-debug' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-internal-debug.php'>oci_internal_debug</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_internal_debug</span> &amp;mdash; <span class='dc-title'>Enables or disables internal debug output</span></p> </div> <a name='function.oci-internal-debug.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>oci_internal_debug</b></span> ( <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$onoff</tt></span> )</div> <p class='para rdfs-comment'> Enables or disables internal debug output. </p> </div> <a name='function.oci-internal-debug.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'>onoff</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Set this to <b><tt class='constant'>FALSE</tt></b> to turn debug output off or <b><tt class='constant'>TRUE</tt></b> to turn it on. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-internal-debug.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.oci-internal-debug.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociinternaldebug.php' class='function'>ociinternaldebug()</a> instead. This name still can be used, it was left as alias of <b>oci_internal_debug()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_free_statement" value="<div id='function.oci-free-statement' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-free-statement.php'>oci_free_statement</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_free_statement</span> &amp;mdash; <span class='dc-title'>Frees all resources associated with statement or cursor</span></p> </div> <a name='function.oci-free-statement.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_free_statement</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Frees resources associated with Oracle&amp;#039;s cursor or statement, which was received from as a result of <a href='http://www.php.net/manual/en/function.oci-parse.php' class='function'>oci_parse()</a> or obtained from Oracle. </p> </div> <a name='function.oci-free-statement.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-free-statement.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_type_raw" value="<div id='function.oci-field-type-raw' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-type-raw.php'>oci_field_type_raw</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_type_raw</span> &amp;mdash; <span class='dc-title'>Tell the raw Oracle data type of the field</span></p> </div> <a name='function.oci-field-type-raw.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>oci_field_type_raw</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns Oracle&amp;#039;s raw data type of the <i><tt class='parameter'>field</tt></i> . </p> <p class='para'> However, if you want to get field&amp;#039;s type, then <a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function'>oci_field_type()</a> will suit you better. </p> </div> <a name='function.oci-field-type-raw.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-type-raw.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns Oracle&amp;#039;s raw data type as a string, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-type-raw.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumntyperaw.php' class='function'>ocicolumntyperaw()</a> instead. This name still can be used, it was left as alias of <b>oci_field_type_raw()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_type" value="<div id='function.oci-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-type.php'>oci_field_type</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_type</span> &amp;mdash; <span class='dc-title'>Returns field&amp;#039;s data type</span></p> </div> <a name='function.oci-field-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>oci_field_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns a field&amp;#039;s data type. </p> </div> <a name='function.oci-field-type.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the field data type as a string, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_field_type()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;emp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border=\'1\'&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Name&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Type&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Length&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$ncols&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>$ncols</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_name&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_type&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_size&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_name</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_type</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_size</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-field-type.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumntype.php' class='function'>ocicolumntype()</a> instead. This name still can be used, it was left as alias of <b>oci_field_type()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-field-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-num-fields.php' class='function' rel='rdfs-seeAlso'>oci_num_fields()</a> - Returns the number of result columns in a statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-name.php' class='function' rel='rdfs-seeAlso'>oci_field_name()</a> - Returns the name of a field from the statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-size.php' class='function' rel='rdfs-seeAlso'>oci_field_size()</a> - Returns field's size</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_size" value="<div id='function.oci-field-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-size.php'>oci_field_size</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_size</span> &amp;mdash; <span class='dc-title'>Returns field&amp;#039;s size</span></p> </div> <a name='function.oci-field-size.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>oci_field_size</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns the size of a <i><tt class='parameter'>field</tt></i> . </p> </div> <a name='function.oci-field-size.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the size of a <i><tt class='parameter'>field</tt></i> in bytes, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-size.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_field_size()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;emp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border=\'1\'&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Name&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Type&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Length&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$ncols&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>$ncols</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_name&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_type&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_size&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_name</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_type</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_size</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-field-size.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumnsize.php' class='function'>ocicolumnsize()</a> instead. This name still can be used, it was left as alias of <b>oci_field_size()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-field-size.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-num-fields.php' class='function' rel='rdfs-seeAlso'>oci_num_fields()</a> - Returns the number of result columns in a statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-name.php' class='function' rel='rdfs-seeAlso'>oci_field_name()</a> - Returns the name of a field from the statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_scale" value="<div id='function.oci-field-scale' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-scale.php'>oci_field_scale</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_scale</span> &amp;mdash; <span class='dc-title'>Tell the scale of the field</span></p> </div> <a name='function.oci-field-scale.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>oci_field_scale</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns the scale of the column with <i><tt class='parameter'>field</tt></i> index. </p> <p class='para'> For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is NUMBER. Else it&amp;#039;s NUMBER(precision, scale). </p> </div> <a name='function.oci-field-scale.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-scale.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the scale as an integer, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-scale.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumnscale.php' class='function'>ocicolumnscale()</a> instead. This name still can be used, it was left as alias of <b>oci_field_scale()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-field-scale.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-precision.php' class='function' rel='rdfs-seeAlso'>oci_field_precision()</a> - Tell the precision of a field</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function' rel='rdfs-seeAlso'>oci_field_type()</a> - Returns field's data type</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_precision" value="<div id='function.oci-field-precision' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-precision.php'>oci_field_precision</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_precision</span> &amp;mdash; <span class='dc-title'>Tell the precision of a field</span></p> </div> <a name='function.oci-field-precision.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>oci_field_precision</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns precision of the <i><tt class='parameter'>field</tt></i> . </p> <p class='para'> For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is NUMBER. Else it&amp;#039;s NUMBER(precision, scale). </p> </div> <a name='function.oci-field-precision.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-precision.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the precision as an integer, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-precision.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumnprecision.php' class='function'>ocicolumnprecision()</a> instead. This name still can be used, it was left as alias of <b>oci_field_precision()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-field-precision.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-scale.php' class='function' rel='rdfs-seeAlso'>oci_field_scale()</a> - Tell the scale of the field</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function' rel='rdfs-seeAlso'>oci_field_type()</a> - Returns field's data type</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_name" value="<div id='function.oci-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-name.php'>oci_field_name</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_name</span> &amp;mdash; <span class='dc-title'>Returns the name of a field from the statement</span></p> </div> <a name='function.oci-field-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>oci_field_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Returns the name of the <i><tt class='parameter'>field</tt></i> . </p> </div> <a name='function.oci-field-name.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s index (1-based) or name. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the name as a string, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.oci-field-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_field_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;emp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border=\'1\'&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Name&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Type&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;Length&amp;lt;/th&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$ncols&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>$ncols</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_name&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_type&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$column_size&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_field_size</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_name</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_type</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$column_size</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-field-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumnname.php' class='function'>ocicolumnname()</a> instead. This name still can be used, it was left as alias of <b>oci_field_name()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-field-name.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-num-fields.php' class='function' rel='rdfs-seeAlso'>oci_num_fields()</a> - Returns the number of result columns in a statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-type.php' class='function' rel='rdfs-seeAlso'>oci_field_type()</a> - Returns field's data type</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-field-size.php' class='function' rel='rdfs-seeAlso'>oci_field_size()</a> - Returns field's size</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_field_is_null" value="<div id='function.oci-field-is-null' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-field-is-null.php'>oci_field_is_null</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_field_is_null</span> &amp;mdash; <span class='dc-title'>Checks if the field is <b><tt class='constant'>NULL</tt></b></span></p> </div> <a name='function.oci-field-is-null.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_field_is_null</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> Checks if the given <i><tt class='parameter'>field</tt></i> from the <i><tt class='parameter'>statement</tt></i> is <b><tt class='constant'>NULL</tt></b>. </p> </div> <a name='function.oci-field-is-null.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be a field&amp;#039;s index or a field&amp;#039;s name (uppercased). </p> </dd> </dl> <p> </p> </div> <a name='function.oci-field-is-null.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>field</tt></i> is <b><tt class='constant'>NULL</tt></b>, <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.oci-field-is-null.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocicolumnisnull.php' class='function'>ocicolumnisnull()</a> instead. This name still can be used, it was left as alias of <b>oci_field_is_null()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch_row" value="<div id='function.oci-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch-row.php'>oci_fetch_row</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch_row</span> &amp;mdash; <span class='dc-title'>Returns the next row from the result data as a numeric array</span></p> </div> <a name='function.oci-fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>oci_fetch_row</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Returns the next row from the result data as an indexed array. </p> <p class='para'> Calling <b>oci_fetch_row()</b> is identical to calling <a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function'>oci_fetch_array()</a> with <b><tt class='constant'>OCI_NUM</tt></b>. </p> <p class='para'> Subsequent calls to <b>oci_fetch_row()</b> will return the next row from the result data or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-fetch-row.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an indexed array with the field information, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows in the <i><tt class='parameter'>statement</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.oci-fetch-row.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function' rel='rdfs-seeAlso'>oci_fetch_array()</a> - Returns the next row from the result data as an associative or numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>oci_fetch_assoc()</a> - Returns the next row from the result data as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-object.php' class='function' rel='rdfs-seeAlso'>oci_fetch_object()</a> - Returns the next row from the result data as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function' rel='rdfs-seeAlso'>oci_fetch_all()</a> - Fetches all rows of result data into an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch_object" value="<div id='function.oci-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch-object.php'>oci_fetch_object</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch_object</span> &amp;mdash; <span class='dc-title'>Returns the next row from the result data as an object</span></p> </div> <a name='function.oci-fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>oci_fetch_object</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Returns the next row from the result data as an object. </p> <p class='para'> Subsequent calls to <b>oci_fetch_object()</b> will return the next row from the result or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-fetch-object.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object, which attributes correspond to fields in statement, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows in the <i><tt class='parameter'>statement</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> Oracle returns all field names in uppercase and associative indices in the result object will be uppercased too. </span> </p></blockquote> </div> <a name='function.oci-fetch-object.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function' rel='rdfs-seeAlso'>oci_fetch_array()</a> - Returns the next row from the result data as an associative or numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>oci_fetch_assoc()</a> - Returns the next row from the result data as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function' rel='rdfs-seeAlso'>oci_fetch_row()</a> - Returns the next row from the result data as a numeric array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function' rel='rdfs-seeAlso'>oci_fetch_all()</a> - Fetches all rows of result data into an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch_assoc" value="<div id='function.oci-fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch-assoc.php'>oci_fetch_assoc</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch_assoc</span> &amp;mdash; <span class='dc-title'>Returns the next row from the result data as an associative array</span></p> </div> <a name='function.oci-fetch-assoc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>oci_fetch_assoc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Returns the next row from the result data as an associative array. </p> <p class='para'> Calling <b>oci_fetch_assoc()</b> is identical to calling <a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function'>oci_fetch_array()</a> with <b><tt class='constant'>OCI_ASSOC</tt></b>. </p> <p class='para'> A subsequent call to <b>oci_fetch_assoc()</b> will return the next row or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-fetch-assoc.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows in the <i><tt class='parameter'>statement</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> Oracle returns all field names in uppercase and associative indices in the result array will be uppercased too. </span> </p></blockquote> </div> <a name='function.oci-fetch-assoc.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-array.php' class='function' rel='rdfs-seeAlso'>oci_fetch_array()</a> - Returns the next row from the result data as an associative or numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-object.php' class='function' rel='rdfs-seeAlso'>oci_fetch_object()</a> - Returns the next row from the result data as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function' rel='rdfs-seeAlso'>oci_fetch_row()</a> - Returns the next row from the result data as a numeric array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function' rel='rdfs-seeAlso'>oci_fetch_all()</a> - Fetches all rows of result data into an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch_array" value="<div id='function.oci-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch-array.php'>oci_fetch_array</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch_array</span> &amp;mdash; <span class='dc-title'>Returns the next row from the result data as an associative or numeric array, or both </span></p> </div> <a name='function.oci-fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>oci_fetch_array</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt></span> ] )</div> <p class='para rdfs-comment'> Returns an array, which corresponds to the next result row. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> <p class='para'> It should be mentioned here, that <b>oci_fetch_array()</b> is <em class='emphasis'>insignificantly</em> slower, than <a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function'>oci_fetch_row()</a>, but much more handy. </p> </div> <a name='function.oci-fetch-array.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An optional second parameter can be any combination of the following constants: </p><ul class='simplelist'> <li class='member'> <b><tt class='constant'>OCI_BOTH</tt></b> - return an array with both associative and numeric indices (the same as <b><tt class='constant'>OCI_ASSOC</tt></b> + <b><tt class='constant'>OCI_NUM</tt></b>). This is the default behavior. </li> <li class='member'> <b><tt class='constant'>OCI_ASSOC</tt></b> - return an associative array (as <a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function'>oci_fetch_assoc()</a> works). </li> <li class='member'> <b><tt class='constant'>OCI_NUM</tt></b> - return a numeric array, (as <a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function'>oci_fetch_row()</a> works). </li> <li class='member'> <b><tt class='constant'>OCI_RETURN_NULLS</tt></b> - create empty elements for the <b><tt class='constant'>NULL</tt></b> fields. </li> <li class='member'> <b><tt class='constant'>OCI_RETURN_LOBS</tt></b> - return the value of a LOB of the descriptor. </li> </ul><p> Default <i><tt class='parameter'>mode</tt></i> is <b><tt class='constant'>OCI_BOTH</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array with both associative and numeric indices, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows in the <i><tt class='parameter'>statement</tt></i> . </p> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> Oracle returns all field names in uppercase and associative indices in the result array will be uppercased too. </span> </p></blockquote> </div> <a name='function.oci-fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_fetch_array()</b> with <b><tt class='constant'>OCI_BOTH</tt></b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'apelsin'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'kanistra'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;fruits'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_array&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_BOTH</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;nbsp;and&amp;nbsp;'</span><span style='color: #007700'>.</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ID'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;the&amp;nbsp;same&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;nbsp;and&amp;nbsp;'</span><span style='color: #007700'>.</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NAME'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;nbsp;is&amp;nbsp;the&amp;nbsp;same&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>oci_fetch_array()</b> with <b><tt class='constant'>OCI_NUM</tt></b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;lob_field&amp;nbsp;FROM&amp;nbsp;fruits'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_array&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_NUM</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]-&amp;gt;</span><span style='color: #0000BB'>read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>100</span><span style='color: #007700'>).</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//this&amp;nbsp;will&amp;nbsp;output&amp;nbsp;first&amp;nbsp;100&amp;nbsp;bytes&amp;nbsp;from&amp;nbsp;LOB<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #3 <b>oci_fetch_array()</b> with <b><tt class='constant'>OCI_ASSOC</tt></b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;lob_field&amp;nbsp;FROM&amp;nbsp;fruits'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_array&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_ASSOC</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ID'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NAME'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'LOB_FIELD'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//this&amp;nbsp;will&amp;nbsp;output&amp;nbsp;'Object&amp;nbsp;id&amp;nbsp;#1'<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #4 <b>oci_fetch_array()</b> with <b><tt class='constant'>OCI_RETURN_LOBS</tt></b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'user'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;lob_field&amp;nbsp;FROM&amp;nbsp;fruits'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$connection</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_array&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;(</span><span style='color: #0000BB'>OCI_NUM</span><span style='color: #007700'>+</span><span style='color: #0000BB'>OCI_RETURN_LOBS</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'LOB_FIELD'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//this&amp;nbsp;will&amp;nbsp;output&amp;nbsp;LOB's&amp;nbsp;content<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-fetch-array.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>oci_fetch_assoc()</a> - Returns the next row from the result data as an associative array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-object.php' class='function' rel='rdfs-seeAlso'>oci_fetch_object()</a> - Returns the next row from the result data as an object</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-row.php' class='function' rel='rdfs-seeAlso'>oci_fetch_row()</a> - Returns the next row from the result data as a numeric array</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-fetch-all.php' class='function' rel='rdfs-seeAlso'>oci_fetch_all()</a> - Fetches all rows of result data into an array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch_all" value="<div id='function.oci-fetch-all' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch-all.php'>oci_fetch_all</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch_all</span> &amp;mdash; <span class='dc-title'>Fetches all rows of result data into an array</span></p> </div> <a name='function.oci-fetch-all.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>oci_fetch_all</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$output</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$skip</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$maxrows</tt><span class='initializer'> = -1</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$flags</tt><span class='initializer'> = 0</span></span> ]]] )</div> <p class='para rdfs-comment'> Fetches all the rows from a result into a user-defined array. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-fetch-all.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>output</tt></i> </span> </dt><dd class='listitem'> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>skip</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of initial rows to ignore when fetching the result (default value of 0, to start at the first line). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>maxrows</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of rows to read, starting at the <i><tt class='parameter'>skip</tt></i> th row (default to -1, meaning all the rows). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>flags</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Parameter <i><tt class='parameter'>flags</tt></i> can be any combination of the following: </p><ul class='simplelist'> <li class='member'> <b><tt class='constant'>OCI_FETCHSTATEMENT_BY_ROW</tt></b> </li> <li class='member'> <b><tt class='constant'>OCI_FETCHSTATEMENT_BY_COLUMN</tt></b> (default value) </li> <li class='member'> <b><tt class='constant'>OCI_NUM</tt></b> </li> <li class='member'> <b><tt class='constant'>OCI_ASSOC</tt></b> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch-all.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows fetched or <b><tt class='constant'>FALSE</tt></b> in case of an error. </p> </div> <a name='function.oci-fetch-all.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_fetch_all()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;oci_fetch_all&amp;nbsp;example&amp;nbsp;mbritton&amp;nbsp;at&amp;nbsp;verinet&amp;nbsp;dot&amp;nbsp;com&amp;nbsp;(990624)&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;emp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$nrows&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_all</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$results</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$nrows&amp;nbsp;</span><span style='color: #007700'>&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border=\'1\'&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$results&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$key&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$val</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;th&amp;gt;</span><span style='color: #0000BB'>$key</span><span style='color: #DD0000'>&amp;lt;/th&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;for&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$nrows</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$results&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>]</span><span style='color: #DD0000'>&amp;lt;/td&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;data&amp;nbsp;found&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />}<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$nrows</span><span style='color: #DD0000'>&amp;nbsp;Records&amp;nbsp;Selected&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-fetch-all.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocifetchstatement.php' class='function'>ocifetchstatement()</a> instead. This name still can be used, it was left as alias of <b>oci_fetch_all()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_fetch" value="<div id='function.oci-fetch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-fetch.php'>oci_fetch</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_fetch</span> &amp;mdash; <span class='dc-title'>Fetches the next row into result-buffer</span></p> </div> <a name='function.oci-fetch.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_fetch</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Fetches the next row (for SELECT statements) into the internal result-buffer. </p> <p class='para'>For details on the data type mapping performed by the oci8 driver, see the <a href='http://www.php.net/manual/en/oci8.datatypes.php' class='link'>datatypes supported by the driver</a></p> </div> <a name='function.oci-fetch.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-fetch.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> if there are no more rows in the <i><tt class='parameter'>statement</tt></i> . </p> </div> <a name='function.oci-fetch.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocifetch.php' class='function'>ocifetch()</a> instead. This name still can be used, it was left as alias of <b>oci_fetch()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_execute" value="<div id='function.oci-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-execute.php'>oci_execute</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_execute</span> &amp;mdash; <span class='dc-title'>Executes a statement</span></p> </div> <a name='function.oci-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_execute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$mode</tt><span class='initializer'> = OCI_COMMIT_ON_SUCCESS</span></span> ] )</div> <p class='para rdfs-comment'> Executes a previously parsed <i><tt class='parameter'>statement</tt></i> . </p> </div> <a name='function.oci-execute.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Allows you to specify the execution mode (default is <b><tt class='constant'>OCI_COMMIT_ON_SUCCESS</tt></b>). </p> <p class='para'> If you don&amp;#039;t want statements to be committed automatically, you should specify <b><tt class='constant'>OCI_DEFAULT</tt></b> as your <i><tt class='parameter'>mode</tt></i> . </p> <p class='para'> When using <b><tt class='constant'>OCI_DEFAULT</tt></b> mode, you&amp;#039;re creating a transaction. Transactions are automatically rolled back when you close the connection, or when the script ends, whichever is soonest. You need to explicitly call <a href='http://www.php.net/manual/en/function.oci-commit.php' class='function'>oci_commit()</a> to commit the transaction, or <a href='http://www.php.net/manual/en/function.oci-rollback.php' class='function'>oci_rollback()</a> to abort it. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-execute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-execute.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ociexecute.php' class='function'>ociexecute()</a> instead. This name still can be used, it was left as alias of <b>oci_execute()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-parse.php' class='function' rel='rdfs-seeAlso'>oci_parse()</a> - Prepares Oracle statement for execution</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_error" value="<div id='function.oci-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-error.php'>oci_error</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_error</span> &amp;mdash; <span class='dc-title'>Returns the last error found</span></p> </div> <a name='function.oci-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>oci_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$source</tt></span> ] )</div> <p class='para rdfs-comment'> Returns the last error found. </p> </div> <a name='function.oci-error.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'>source</tt></i> </span> </dt><dd class='listitem'> <p class='para'> For most errors, the parameter is the most appropriate resource handle. For connection errors with <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a>, <a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function'>oci_new_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a> do not pass a parameter. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> If no error is found, <b>oci_error()</b> returns <b><tt class='constant'>FALSE</tt></b>. <b>oci_error()</b> returns the error as an associative array. In this array, <i>code</i> consists the oracle error code and <i>message</i> the oracle error string. </p> </div> <a name='function.oci-error.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.3</td> <td align='left'> <i>offset</i> and <i>sqltext</i> will also be included in the return array to indicate the location of the error and the original SQL text which caused it. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.oci-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Displaying the Oracle error message after a connection error</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> $conn&amp;nbsp;=&amp;nbsp;@oci_connect('scott',&amp;nbsp;'tiger',&amp;nbsp;'mydb');<br />if&amp;nbsp;(!$conn)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;$e&amp;nbsp;=&amp;nbsp;oci_error();&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;For&amp;nbsp;oci_connect&amp;nbsp;errors&amp;nbsp;pass&amp;nbsp;no&amp;nbsp;handle<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;htmlentities($e['message']);<br />}</span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Displaying the Oracle error message after a parsing error</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> $stmt&amp;nbsp;=&amp;nbsp;@oci_parse($conn,&amp;nbsp;'select&amp;nbsp;'&amp;nbsp;from&amp;nbsp;dual');&amp;nbsp;&amp;nbsp;//&amp;nbsp;note&amp;nbsp;mismatched&amp;nbsp;quote<br />if&amp;nbsp;(!$stmt)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;$e&amp;nbsp;=&amp;nbsp;oci_error($conn);&amp;nbsp;&amp;nbsp;//&amp;nbsp;For&amp;nbsp;oci_parse&amp;nbsp;errors&amp;nbsp;pass&amp;nbsp;the&amp;nbsp;connection&amp;nbsp;handle<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;htmlentities($e['message']);<br />}</span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #3 Displaying the Oracle error message and problematic statement after an execution error</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> $r&amp;nbsp;=&amp;nbsp;oci_execute($stmt);<br />if&amp;nbsp;(!$r)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;$e&amp;nbsp;=&amp;nbsp;oci_error($stmt);&amp;nbsp;//&amp;nbsp;For&amp;nbsp;oci_execute&amp;nbsp;errors&amp;nbsp;pass&amp;nbsp;the&amp;nbsp;statementhandle<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;htmlentities($e['message']);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'&amp;lt;pre&amp;gt;';<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;htmlentities($e['sqltext']);<br />&amp;nbsp;&amp;nbsp;printf('\n%'.($e['offset']+1).'s',&amp;nbsp;'^');<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;'&amp;lt;/pre&amp;gt;';<br />}</span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-error.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocierror.php' class='function'>ocierror()</a> instead. This name still can be used, it was left as alias of <b>oci_error()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_define_by_name" value="<div id='function.oci-define-by-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-define-by-name.php'>oci_define_by_name</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_define_by_name</span> &amp;mdash; <span class='dc-title'>Uses a PHP variable for the define-step during a SELECT</span></p> </div> <a name='function.oci-define-by-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_define_by_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column_name</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter reference'>&amp;amp;$variable</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt><span class='initializer'> = SQLT_CHR</span></span> ] )</div> <p class='para rdfs-comment'> Defines PHP variables for fetches of SQL-Columns. </p> </div> <a name='function.oci-define-by-name.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The column name. Must be uppercased. </p> <p class='para'> Take into consideration that Oracle uses ALL-UPPERCASE column names, whereby in your select you can also use lowercase. If you define a variable that doesn&amp;#039;t exists in your select statement, no error will be issued. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>variable</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The PHP variable. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> <p class='para'> If you need to define an abstract datatype (LOB/ROWID/BFILE) you must allocate it first using <a href='http://www.php.net/manual/en/function.oci-new-descriptor.php' class='function'>oci_new_descriptor()</a>. See also the <a href='http://www.php.net/manual/en/function.oci-bind-by-name.php' class='function'>oci_bind_by_name()</a> function. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-define-by-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-define-by-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_define_by_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;oci_define_by_name&amp;nbsp;example&amp;nbsp;-&amp;nbsp;thies&amp;nbsp;at&amp;nbsp;thieso&amp;nbsp;dot&amp;nbsp;net&amp;nbsp;(980219)&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;empno,&amp;nbsp;ename&amp;nbsp;FROM&amp;nbsp;emp'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;the&amp;nbsp;define&amp;nbsp;MUST&amp;nbsp;be&amp;nbsp;done&amp;nbsp;BEFORE&amp;nbsp;oci_execute!&amp;nbsp;*/<br /><br /></span><span style='color: #0000BB'>oci_define_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'EMPNO'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$empno</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_define_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ENAME'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ename</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>oci_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'empno:'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$empno&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'ename:'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$ename&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-define-by-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocidefinebyname.php' class='function'>ocidefinebyname()</a> instead. This name still can be used, it was left as alias of <b>oci_define_by_name()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_connect" value="<div id='function.oci-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-connect.php'>oci_connect</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_connect</span> &amp;mdash; <span class='dc-title'>Establishes a connection to the Oracle server</span></p> </div> <a name='function.oci-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>oci_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$db</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$charset</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$session_mode</tt></span> ]]] )</div> <p class='para rdfs-comment'> Returns a connection identifier needed for most other OCI calls. </p> </div> <a name='function.oci-connect.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'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Oracle user name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password for <i><tt class='parameter'>username</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>db</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This optional parameter can either contain the name of the local Oracle instance or the name of the entry in <var class='filename'>tnsnames.ora</var>. </p> <p class='para'> If the not specified, PHP uses environment variables <b><tt class='constant'>ORACLE_SID</tt></b> and <b><tt class='constant'>TWO_TASK</tt></b> to determine the name of local <i>Oracle instance</i> and location of <var class='filename'>tnsnames.ora</var> accordingly. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>charset</tt></i> </span> </dt><dd class='listitem'> <p class='para'>Using Oracle server version 9.2 and greater, you can indicate <i><tt class='parameter'>charset</tt></i> by parameter, which will be used in the new connection. If you&amp;#039;re using Oracle server &amp;lt; 9.2, this parameter will be ignored and the <i>NLS_LANG</i> environment variable will be used instead. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>session_mode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This parameter is available since version 1.1 and accepts the following values: <b><tt class='constant'>OCI_DEFAULT</tt></b>, <b><tt class='constant'>OCI_SYSOPER</tt></b> and <b><tt class='constant'>OCI_SYSDBA</tt></b>. If either <b><tt class='constant'>OCI_SYSOPER</tt></b> or <b><tt class='constant'>OCI_SYSDBA</tt></b> were specified, this function will try to establish privileged connection using external credentials. Privileged connections are disabled by default. To enable them you need to set <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.privileged-connect' class='link'>oci8.privileged_connect</a> to <i>On</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a connection identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_connect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;pre&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$c1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$c2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>);<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>create_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'create&amp;nbsp;table&amp;nbsp;scott.hallo&amp;nbsp;(test&amp;nbsp;varchar2(64))'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;created&amp;nbsp;table\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>drop_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'drop&amp;nbsp;table&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;dropped&amp;nbsp;table\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'insert&amp;nbsp;into&amp;nbsp;scott.hallo<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;values('</span><span style='color: #0000BB'>$conn</span><span style='color: #DD0000'>'&amp;nbsp;||&amp;nbsp;'&amp;nbsp;'&amp;nbsp;||&amp;nbsp;to_char(sysdate,'DD-MON-YY&amp;nbsp;HH24:MI:SS'))'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;inserted&amp;nbsp;hallo\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>delete_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'delete&amp;nbsp;from&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;deleted&amp;nbsp;hallo\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;committed\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;rollback\n\n'</span><span style='color: #007700'>;<br />}<br /><br />function&amp;nbsp;</span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;scott.hallo'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>.</span><span style='color: #DD0000'>'----selecting\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>oci_fetch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;['&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>oci_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'TEST'</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>']\n\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'----done\n\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>create_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Insert&amp;nbsp;a&amp;nbsp;row&amp;nbsp;using&amp;nbsp;c1<br /></span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Insert&amp;nbsp;a&amp;nbsp;row&amp;nbsp;using&amp;nbsp;c2<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Results&amp;nbsp;of&amp;nbsp;both&amp;nbsp;inserts&amp;nbsp;are&amp;nbsp;returned<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>rollback</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Rollback&amp;nbsp;using&amp;nbsp;c1<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Both&amp;nbsp;inserts&amp;nbsp;have&amp;nbsp;been&amp;nbsp;rolled&amp;nbsp;back<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>insert_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Insert&amp;nbsp;a&amp;nbsp;row&amp;nbsp;using&amp;nbsp;c2<br /></span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Commit&amp;nbsp;using&amp;nbsp;c2<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Result&amp;nbsp;of&amp;nbsp;c2&amp;nbsp;insert&amp;nbsp;is&amp;nbsp;returned<br /><br /></span><span style='color: #0000BB'>delete_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Delete&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;table&amp;nbsp;using&amp;nbsp;c1<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;No&amp;nbsp;rows&amp;nbsp;returned<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;No&amp;nbsp;rows&amp;nbsp;returned<br /></span><span style='color: #0000BB'>commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Commit&amp;nbsp;using&amp;nbsp;c1<br /><br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;No&amp;nbsp;rows&amp;nbsp;returned<br /></span><span style='color: #0000BB'>select_data</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c2</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;No&amp;nbsp;rows&amp;nbsp;returned<br /><br /></span><span style='color: #0000BB'>drop_table</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c1</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/pre&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-connect.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> If you&amp;#039;re using PHP with Oracle Instant Client, you can use easy connect naming method described here: <a href='http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306' class='link external'>&amp;raquo; http://download-west.oracle.com/docs/cd/B12037_01/network.101/b10775/naming.htm#i498306</a>. Basically this means you can specify &amp;quot;//db_host[:port]/database_name&amp;quot; as database name. But if you want to use the old way of naming you <em class='emphasis'>must</em> set either <b><tt class='constant'>ORACLE_HOME</tt></b> or <b><tt class='constant'>TNS_ADMIN</tt></b>. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'> The second and subsequent calls to <b>oci_connect()</b> with the same parameters will return the connection handle returned from the first call. This means that queries issued against one handle are also applied to the other handles, because they are the <em class='emphasis'>same</em> handle. This behaviour is demonstrated in Example 1 below. If you require two handles to be transactionally isolated from each other, you should use <a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function'>oci_new_connect()</a> instead. </span> </p></blockquote> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocilogon.php' class='function'>ocilogon()</a> instead. This name still can be used, it was left as the alias of <b>oci_connect()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> <a name='function.oci-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function' rel='rdfs-seeAlso'>oci_pconnect()</a> - Connect to an Oracle database using a persistent connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-new-connect.php' class='function' rel='rdfs-seeAlso'>oci_new_connect()</a> - Establishes a new connection to the Oracle server</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-close.php' class='function' rel='rdfs-seeAlso'>oci_close()</a> - Closes Oracle connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_commit" value="<div id='function.oci-commit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-commit.php'>oci_commit</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_commit</span> &amp;mdash; <span class='dc-title'>Commits outstanding statements</span></p> </div> <a name='function.oci-commit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_commit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Commits all outstanding statements for the active transaction on the Oracle <i><tt class='parameter'>connection</tt></i> . </p> </div> <a name='function.oci-commit.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a> or <a href='http://www.php.net/manual/en/function.oci-pconnect.php' class='function'>oci_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-commit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-commit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_commit()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Login&amp;nbsp;to&amp;nbsp;Oracle&amp;nbsp;server<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Parse&amp;nbsp;SQL<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;INSERT&amp;nbsp;INTO<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;employees&amp;nbsp;(name,&amp;nbsp;surname)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;VALUES<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;('Maxim',&amp;nbsp;'Maletsky')<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Execute&amp;nbsp;statement<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;OCI_DEFAULT&amp;nbsp;tells&amp;nbsp;oci_execute()<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;not&amp;nbsp;to&amp;nbsp;commit&amp;nbsp;statement&amp;nbsp;immediately&amp;nbsp;*/<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_DEFAULT</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*<br />....<br />Parsing&amp;nbsp;and&amp;nbsp;executing&amp;nbsp;other&amp;nbsp;statements&amp;nbsp;here&amp;nbsp;...<br />....<br />*/<br /><br />//&amp;nbsp;Commit&amp;nbsp;transaction<br /></span><span style='color: #0000BB'>$committed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_commit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Test&amp;nbsp;whether&amp;nbsp;commit&amp;nbsp;was&amp;nbsp;successful.&amp;nbsp;If&amp;nbsp;error&amp;nbsp;occurred,&amp;nbsp;return&amp;nbsp;error&amp;nbsp;message<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>$committed</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$error&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Commit&amp;nbsp;failed.&amp;nbsp;Oracle&amp;nbsp;reports:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$error</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'message'</span><span style='color: #007700'>];<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-commit.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Transactions are automatically rolled back when you close the connection, or when the script ends, whichever is soonest. You need to explicitly call <b>oci_commit()</b> to commit the transaction, or <a href='http://www.php.net/manual/en/function.oci-rollback.php' class='function'>oci_rollback()</a> to abort it. <br /> </p></blockquote> </div> <a name='function.oci-commit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-rollback.php' class='function' rel='rdfs-seeAlso'>oci_rollback()</a> - Rolls back outstanding transaction</li> <li class='member'><a href='http://www.php.net/manual/en/function.oci-execute.php' class='function' rel='rdfs-seeAlso'>oci_execute()</a> - Executes a statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_trim" value="<div id='function.oci-collection-trim' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-trim.php'>OCI-Collection-&amp;gt;trim</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;trim</span> &amp;mdash; <span class='dc-title'>Trims elements from the end of the collection</span></p> </div> <a name='function.oci-collection-trim.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.trim.php' class='function'>trim</a></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$num</tt></span> )</div> </div> <p class='para'> Trims <i><tt class='parameter'>num</tt></i> of elements from the end of the collection. </p> </div> <a name='function.oci-collection-trim.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'>num</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of elements to be trimmed. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-collection-trim.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-collection-trim.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-size.php' class='xref'>OCI-Collection->size</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_size" value="<div id='function.oci-collection-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-size.php'>OCI-Collection-&amp;gt;size</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;size</span> &amp;mdash; <span class='dc-title'>Returns size of the collection</span></p> </div> <a name='function.oci-collection-size.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><b>size</b></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Returns the size of the collection. </p> </div> <a name='function.oci-collection-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of elements in the collection or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.oci-collection-size.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-max.php' class='xref'>OCI-Collection->max</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_max" value="<div id='function.oci-collection-max' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-max.php'>OCI-Collection-&amp;gt;max</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;max</span> &amp;mdash; <span class='dc-title'>Returns the maximum number of elements in the collection</span></p> </div> <a name='function.oci-collection-max.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>int</span> <span class='methodname'><a href='http://www.php.net/manual/en/function.max.php' class='function'>max</a></span> ( <span class='methodparam'>void</span> )</div> </div> <p class='para'> Returns the maximum number of elements in the collection. </p> </div> <a name='function.oci-collection-max.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the maximum number as an integer, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> <p class='para'> If the returned value is 0, then the number of elements is not limited. </p> </div> <a name='function.oci-collection-max.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-size.php' class='xref'>OCI-Collection->size</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_element_get" value="<div id='function.oci-collection-element-get' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-element-get.php'>OCI-Collection-&amp;gt;getElem</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;getElem</span> &amp;mdash; <span class='dc-title'>Returns value of the element</span></p> </div> <a name='function.oci-collection-element-get.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>mixed</span> <span class='methodname'><b>getElem</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> )</div> </div> <p class='para'> Returns element&amp;#039;s value with the index <i><tt class='parameter'>index</tt></i> (1-based). </p> </div> <a name='function.oci-collection-element-get.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'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The element index. First index is 1. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-collection-element-get.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> if such element doesn&amp;#039;t exist; <b><tt class='constant'>NULL</tt></b> if element is <b><tt class='constant'>NULL</tt></b>; string if element is column of a string datatype or number if element is numeric field. </p> </div> <a name='function.oci-collection-element-get.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-element-assign.php' class='xref'>OCI-Collection->assignElem</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_element_assign" value="<div id='function.oci-collection-element-assign' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-element-assign.php'>OCI-Collection-&amp;gt;assignElem</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;assignElem</span> &amp;mdash; <span class='dc-title'>Assigns a value to the element of the collection</span></p> </div> <a name='function.oci-collection-element-assign.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>assignElem</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$index</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$value</tt></span> )</div> </div> <p class='para'> Assigns a value to the element with index <i><tt class='parameter'>index</tt></i> . </p> </div> <a name='function.oci-collection-element-assign.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'>index</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The element index. First index is 1. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be a string or a number. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-collection-element-assign.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-collection-element-assign.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-element-get.php' class='xref'>OCI-Collection->getElem</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_assign" value="<div id='function.oci-collection-assign' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-assign.php'>OCI-Collection-&amp;gt;assign</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;assign</span> &amp;mdash; <span class='dc-title'>Assigns a value to the collection from another existing collection</span></p> </div> <a name='function.oci-collection-assign.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>assign</b></span> ( <span class='methodparam'><span class='type'><span class='type OCI-Collection'>OCI-Collection</span></span> <tt class='parameter'>$from</tt></span> )</div> </div> <p class='para'> Assigns a value to the collection from another, previously created collection. Both collections must be created with <a href='http://www.php.net/manual/en/function.oci-new-collection.php' class='function'>oci_new_collection()</a> prior to using them. </p> </div> <a name='function.oci-collection-assign.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'>from</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An instance of OCI-Collection. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-collection-assign.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-collection-assign.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-append.php' class='xref'>OCI-Collection->append</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_collection_append" value="<div id='function.oci-collection-append' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-collection-append.php'>OCI-Collection-&amp;gt;append</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>OCI-Collection-&amp;gt;append</span> &amp;mdash; <span class='dc-title'>Appends element to the collection</span></p> </div> <a name='function.oci-collection-append.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='classsynopsis'> <div class='ooclass'><b class='classname'>OCI-Collection</b></div> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>append</b></span> ( <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$value</tt></span> )</div> </div> <p class='para'> Appends element to the end of the collection. </p> </div> <a name='function.oci-collection-append.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'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The value to be added to the collection. Can be a string or a number. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-collection-append.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-collection-append.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.oci-collection-assign.php' class='xref'>OCI-Collection->assign</a></li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_close" value="<div id='function.oci-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-close.php'>oci_close</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_close</span> &amp;mdash; <span class='dc-title'>Closes Oracle connection</span></p> </div> <a name='function.oci-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Closes the Oracle <i><tt class='parameter'>connection</tt></i> . </p> </div> <a name='function.oci-close.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An Oracle connection identifier, returned by <a href='http://www.php.net/manual/en/function.oci-connect.php' class='function'>oci_connect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-close.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: Starting from the version 1.1 <b>oci_close()</b> correctly closes the Oracle connection. Use <a href='http://www.php.net/manual/en/oci8.configuration.php#ini.oci8.old-oci-close-semantics' class='link'>oci8.old_oci_close_semantics</a> option to restore old behaviour of this function. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_cancel" value="<div id='function.oci-cancel' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-cancel.php'>oci_cancel</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_cancel</span> &amp;mdash; <span class='dc-title'>Cancels reading from cursor</span></p> </div> <a name='function.oci-cancel.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_cancel</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> )</div> <p class='para rdfs-comment'> Invalidates a cursor, freeing all associated resources and cancels the ability to read from it. </p> </div> <a name='function.oci-cancel.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An OCI statement. </p> </dd> </dl> <p> </p> </div> <a name='function.oci-cancel.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_bind_by_name" value="<div id='function.oci-bind-by-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-bind-by-name.php'>oci_bind_by_name</a></h1> <p class='verinfo'>(PHP 5, PECL oci8 &amp;gt;= 1.1.0)</p><p class='refpurpose'><span class='refname'>oci_bind_by_name</span> &amp;mdash; <span class='dc-title'>Binds the PHP variable to the Oracle placeholder</span></p> </div> <a name='function.oci-bind-by-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_bind_by_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$ph_name</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter reference'>&amp;amp;$variable</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$maxlength</tt><span class='initializer'> = -1</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt><span class='initializer'> = SQLT_CHR</span></span> ]] )</div> <p class='para rdfs-comment'> Binds the PHP variable <i><tt class='parameter'>variable</tt></i> to the Oracle placeholder <i><tt class='parameter'>ph_name</tt></i> . Whether it will be used for input or output will be determined at run-time and the necessary storage space will be allocated. </p> </div> <a name='function.oci-bind-by-name.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An OCI statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ph_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The placeholder. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>variable</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The PHP variable. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>maxlength</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the maximum length for the bind. If you set it to -1, this function will use the current length of <i><tt class='parameter'>variable</tt></i> to set the maximum length. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If you need to bind an abstract datatype (LOB/ROWID/BFILE) you need to allocate it first using the <a href='http://www.php.net/manual/en/function.oci-new-descriptor.php' class='function'>oci_new_descriptor()</a> function. The <i><tt class='parameter'>length</tt></i> is not used for abstract datatypes and should be set to -1. The <i><tt class='parameter'>type</tt></i> parameter tells Oracle which descriptor is used. Default to <b><tt class='constant'>SQLT_CHR</tt></b>. Possible values are: </p><ul class='itemizedlist'> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_FILE</tt></b> - for BFILEs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_CFILE</tt></b> - for CFILEs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_CLOB</tt></b> - for CLOBs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_BLOB</tt></b> - for BLOBs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_RDD</tt></b> - for ROWIDs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_NTY</tt></b> - for named datatypes; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_INT</tt></b> - for integers; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_CHR</tt></b> - for VARCHARs; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_BIN</tt></b> - for RAW columns; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_LNG</tt></b> - for LONG columns; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_LBI</tt></b> - for LONG RAW columns; </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_RSET</tt></b> - for cursors, that were created before with <a href='http://www.php.net/manual/en/function.oci-new-cursor.php' class='function'>oci_new_cursor()</a>. </p> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-bind-by-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-bind-by-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_bind_by_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;oci_bind_by_name&amp;nbsp;example&amp;nbsp;thies&amp;nbsp;at&amp;nbsp;thieso&amp;nbsp;dot&amp;nbsp;net&amp;nbsp;(980221)<br />&amp;nbsp;&amp;nbsp;inserts&amp;nbsp;3&amp;nbsp;records&amp;nbsp;into&amp;nbsp;emp,&amp;nbsp;and&amp;nbsp;uses&amp;nbsp;the&amp;nbsp;ROWID&amp;nbsp;for&amp;nbsp;updating&amp;nbsp;the<br />&amp;nbsp;&amp;nbsp;records&amp;nbsp;just&amp;nbsp;after&amp;nbsp;the&amp;nbsp;insert.<br />*/<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;INSERT&amp;nbsp;INTO<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;emp&amp;nbsp;(empno,&amp;nbsp;ename)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;VALUES<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;(:empno,:ename)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;RETURNING<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;ROWID<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;INTO<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;:rid<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>1111&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Larry'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>2222&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Bill'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>3333&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'Jim'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$rowid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_new_descriptor</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_D_ROWID</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':empno'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$empno</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':ename'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ename</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':rid'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rowid</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_ROWID</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$update&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;UPDATE<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;emp<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;SET<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;sal&amp;nbsp;=&amp;nbsp;:sal<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;ROWID&amp;nbsp;=&amp;nbsp;:rid<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$update</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':rid'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$rowid</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>OCI_B_ROWID</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$update</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':sal'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sal</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>32</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$sal&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>10000</span><span style='color: #007700'>;<br /><br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$empno&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$ename</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$update</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>$rowid</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>free</span><span style='color: #007700'>();<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$update</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;SELECT<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FROM<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;emp<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;empno<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IN<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;(1111,2222,3333)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;delete&amp;nbsp;our&amp;nbsp;'junk'&amp;nbsp;from&amp;nbsp;the&amp;nbsp;emp&amp;nbsp;table....&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;DELETE&amp;nbsp;FROM<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;emp<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;empno<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IN<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;(1111,2222,3333)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> Remember, this function strips trailing whitespace. See the following example: </p> <p class='para'> </p><div class='example'> <p><b>Example #2 <b>oci_bind_by_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'apelsin'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'kanistra'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;test_table&amp;nbsp;VALUES(:id,&amp;nbsp;:text)'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':text'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trailing&amp;nbsp;spaces&amp;nbsp;follow&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;This&amp;nbsp;code&amp;nbsp;will&amp;nbsp;insert&amp;nbsp;into&amp;nbsp;DB&amp;nbsp;string&amp;nbsp;'trailing&amp;nbsp;spaces&amp;nbsp;follow',&amp;nbsp;without<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;trailing&amp;nbsp;spaces<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*/<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #3 <b>oci_bind_by_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$connection&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'apelsin'</span><span style='color: #007700'>,</span><span style='color: #DD0000'>'kanistra'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;test_table&amp;nbsp;VALUES(:id,&amp;nbsp;'trailing&amp;nbsp;spaces&amp;nbsp;follow&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;')'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_bind_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':id'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;And&amp;nbsp;this&amp;nbsp;code&amp;nbsp;will&amp;nbsp;add&amp;nbsp;'trailing&amp;nbsp;spaces&amp;nbsp;follow&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;',&amp;nbsp;preserving<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;trailing&amp;nbsp;whitespaces<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;*/<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-bind-by-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-bind-by-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b> <p class='para'> Do not use <a href='http://www.php.net/manual/en/info.configuration.php#ini.magic-quotes-gpc' class='link'>magic_quotes_gpc</a> or <a href='http://www.php.net/manual/en/function.addslashes.php' class='function'>addslashes()</a> and <b>oci_bind_by_name()</b> simultaneously as no quoting is needed and any magically applied quotes will be written into your database as <b>oci_bind_by_name()</b> is not able to distinguish magically added quotings from those added intentionally. </p> </div> <blockquote><p><b class='note'>Note</b>: In PHP versions before 5.0.0 you must use <a href='http://www.php.net/manual/en/function.ocibindbyname.php' class='function'>ocibindbyname()</a> instead. This name still can be used, it was left as alias of <b>oci_bind_by_name()</b> for downwards compatability. This, however, is deprecated and not recommended. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="oci_bind_array_by_name" value="<div id='function.oci-bind-array-by-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.oci-bind-array-by-name.php'>oci_bind_array_by_name</a></h1> <p class='verinfo'>(PHP 5 &amp;gt;= 5.1.2, PECL oci8 &amp;gt;= 1.2.0)</p><p class='refpurpose'><span class='refname'>oci_bind_array_by_name</span> &amp;mdash; <span class='dc-title'>Binds PHP array to Oracle PL/SQL array by name</span></p> </div> <a name='function.oci-bind-array-by-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>oci_bind_array_by_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$statement</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$name</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$var_array</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$max_table_length</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$max_item_length</tt><span class='initializer'> = -1</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt><span class='initializer'> = SQLT_AFC</span></span> ]] )</div> <p class='para rdfs-comment'> Binds the PHP array <i><tt class='parameter'>var_array</tt></i> to the Oracle placeholder <i><tt class='parameter'>name</tt></i> , which points to Oracle PL/SQL array. Whether it will be used for input or output will be determined at run-time. </p> </div> <a name='function.oci-bind-array-by-name.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'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid OCI statement identifier. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The Oracle placeholder. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var_array</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max_table_length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the maximum length both for incoming and result arrays. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>max_item_length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets maximum length for array items. If not specified or equals to -1, <b>oci_bind_array_by_name()</b> will use find the longest element in the incoming array and will use it as maximum length for array items. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should be used to set the type of PL/SQL array items. See list of available types below: </p> <p class='para'> </p><ul class='itemizedlist'> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_NUM</tt></b> - for arrays of NUMBER. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_INT</tt></b> - for arrays of INTEGER (Note: INTEGER it is actually a synonym for NUMBER(38), but <b><tt class='constant'>SQLT_NUM</tt></b> type won&amp;#039;t work in this case even though they are synonyms). </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_FLT</tt></b> - for arrays of FLOAT. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_AFC</tt></b> - for arrays of CHAR. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_CHR</tt></b> - for arrays of VARCHAR2. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_VCS</tt></b> - for arrays of VARCHAR. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_AVC</tt></b> - for arrays of CHARZ. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_STR</tt></b> - for arrays of STRING. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_LVC</tt></b> - for arrays of LONG VARCHAR. </p> </li> <li class='listitem'> <p class='para'> <b><tt class='constant'>SQLT_ODT</tt></b> - for arrays of DATE. </p> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.oci-bind-array-by-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.oci-bind-array-by-name.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>oci_bind_array_by_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$c&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'scott'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'tiger'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;bind_example(name&amp;nbsp;VARCHAR(20))'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$create_pkg&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />CREATE&amp;nbsp;OR&amp;nbsp;REPLACE&amp;nbsp;PACKAGE&amp;nbsp;ARRAYBINDPKG1&amp;nbsp;AS<br />&amp;nbsp;&amp;nbsp;TYPE&amp;nbsp;ARRTYPE&amp;nbsp;IS&amp;nbsp;TABLE&amp;nbsp;OF&amp;nbsp;VARCHAR(20)&amp;nbsp;INDEX&amp;nbsp;BY&amp;nbsp;BINARY_INTEGER;<br />&amp;nbsp;&amp;nbsp;PROCEDURE&amp;nbsp;iobind(c1&amp;nbsp;IN&amp;nbsp;OUT&amp;nbsp;ARRTYPE);<br />END&amp;nbsp;ARRAYBINDPKG1;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create_pkg</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$create_pkg_body&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />CREATE&amp;nbsp;OR&amp;nbsp;REPLACE&amp;nbsp;PACKAGE&amp;nbsp;BODY&amp;nbsp;ARRAYBINDPKG1&amp;nbsp;AS<br />&amp;nbsp;&amp;nbsp;CURSOR&amp;nbsp;CUR&amp;nbsp;IS&amp;nbsp;SELECT&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;bind_example;<br />&amp;nbsp;&amp;nbsp;PROCEDURE&amp;nbsp;iobind(c1&amp;nbsp;IN&amp;nbsp;OUT&amp;nbsp;ARRTYPE)&amp;nbsp;IS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;BEGIN<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FOR&amp;nbsp;i&amp;nbsp;IN&amp;nbsp;1..5&amp;nbsp;LOOP<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;INSERT&amp;nbsp;INTO&amp;nbsp;bind_example&amp;nbsp;VALUES&amp;nbsp;(c1(i));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;END&amp;nbsp;LOOP;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IF&amp;nbsp;NOT&amp;nbsp;CUR%ISOPEN&amp;nbsp;THEN<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;OPEN&amp;nbsp;CUR;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;END&amp;nbsp;IF;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FOR&amp;nbsp;i&amp;nbsp;IN&amp;nbsp;REVERSE&amp;nbsp;1..5&amp;nbsp;LOOP<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FETCH&amp;nbsp;CUR&amp;nbsp;INTO&amp;nbsp;c1(i);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;IF&amp;nbsp;CUR%NOTFOUND&amp;nbsp;THEN<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;CLOSE&amp;nbsp;CUR;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;EXIT;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;END&amp;nbsp;IF;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;END&amp;nbsp;LOOP;<br />&amp;nbsp;&amp;nbsp;END&amp;nbsp;iobind;<br />END&amp;nbsp;ARRAYBINDPKG1;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create_pkg_body</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$statement&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>oci_parse</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$c</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'BEGIN&amp;nbsp;ARRAYBINDPKG1.iobind(:c1);&amp;nbsp;END;'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$array&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'one'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'two'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'three'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'four'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'five'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_bind_array_by_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>':c1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$array</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>5</span><span style='color: #007700'>,&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>SQLT_CHR</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>oci_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$statement</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$array</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.oci-bind-array-by-name.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is available since OCI8 release 1.2. <br /> </p></blockquote> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_select_db" value="<div id='function.mssql-select-db' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-select-db.php'>mssql_select_db</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_select_db</span> &amp;mdash; <span class='dc-title'>Select MS SQL database</span></p> </div> <a name='function.mssql-select-db.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_select_db</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database_name</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> <b>mssql_select_db()</b> sets the current active database on the server that&amp;#039;s associated with the specified link identifier. </p> <p class='para'> Every subsequent call to <a href='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a> will be made on the active database. </p> </div> <a name='function.mssql-select-db.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'>database_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database name. </p> <p class='para'> To escape the name of a database that contains spaces, hyphens (&amp;quot;-&amp;quot;), or any other exceptional characters, the database name must be enclosed in brackets, as is shown in the example, below. This technique must also be applied when selecting a database name that is also a reserved word (such as <i>primary</i>). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MS SQL link identifier, returned by <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> or <a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function'>mssql_pconnect()</a>. </p> <p class='para'> If no link identifier is specified, the last opened link is assumed. If no link is open, the function will try to establish a link as if <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> was called, and use it. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-select-db.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-select-db.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_select_db()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;link&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;the&amp;nbsp;database&amp;nbsp;'php'<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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-select-db.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function' rel='rdfs-seeAlso'>mssql_connect()</a> - Open MS SQL server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function' rel='rdfs-seeAlso'>mssql_pconnect()</a> - Open persistent MS SQL connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-query.php' class='function' rel='rdfs-seeAlso'>mssql_query()</a> - Send MS SQL query</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_rows_affected" value="<div id='function.mssql-rows-affected' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-rows-affected.php'>mssql_rows_affected</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_rows_affected</span> &amp;mdash; <span class='dc-title'>Returns the number of records affected by the query</span></p> </div> <a name='function.mssql-rows-affected.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_rows_affected</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of records affected by the last write query. </p> </div> <a name='function.mssql-rows-affected.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MS SQL link identifier, returned by <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> or <a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function'>mssql_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-rows-affected.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of records affected by last operation. </p> </div> <a name='function.mssql-rows-affected.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_rows_affected()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Delete&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;in&amp;nbsp;a&amp;nbsp;table<br /></span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'TRUNCATE&amp;nbsp;TABLE&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Deleted&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_rows_affected</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;row(s)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_result" value="<div id='function.mssql-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-result.php'>mssql_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_result</span> &amp;mdash; <span class='dc-title'>Get result data</span></p> </div> <a name='function.mssql-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mssql_result</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'>$row</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$field</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_result()</b> returns the contents of one cell from a MS SQL result set. </p> </div> <a name='function.mssql-result.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The row number. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Can be the field&amp;#039;s offset, the field&amp;#039;s name or the field&amp;#039;s table dot field&amp;#039;s name (tablename.fieldname). If the column name has been aliased (&amp;#039;select foo as bar from...&amp;#039;), it uses the alias instead of the column name. </p> <blockquote><p><b class='note'>Note</b>: Specifying a numeric offset for the <i><tt class='parameter'>field</tt></i> argument is much quicker than specifying a <i>fieldname</i> or <i>tablename.fieldname</i> argument. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.mssql-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the contents of the specified cell. </p> </div> <a name='function.mssql-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;were&amp;nbsp;any&amp;nbsp;records<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;records&amp;nbsp;found'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>mssql_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</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> Kalle Felipe Emil Ross </pre></div> </div> </div><p> </p> <p class='para'> </p><div class='example'> <p><b>Example #2 Faster alternative to above example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;were&amp;nbsp;any&amp;nbsp;records<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;records&amp;nbsp;found'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-result.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: When working on large result sets, you should consider using one of the functions that fetch an entire row (specified below). As these functions return the contents of multiple cells in one function call, they&amp;#039;re MUCH quicker than <b>mssql_result()</b>. <br /> </p></blockquote> </div> <a name='function.mssql-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> Recommended high-performance alternatives: </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_row()</a> - Get row as enumerated array</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_assoc()</a> - Returns an associative array of the current row in the result</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-object.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_object()</a> - Fetch row as object</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_query" value="<div id='function.mssql-query' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-query.php'>mssql_query</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_query</span> &amp;mdash; <span class='dc-title'>Send MS SQL query</span></p> </div> <a name='function.mssql-query.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>mssql_query</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$query</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$batch_size</tt><span class='initializer'> = 0</span></span> ]] )</div> <p class='para rdfs-comment'> <b>mssql_query()</b> sends a query to the currently active database on the server that&amp;#039;s associated with the specified link identifier. </p> </div> <a name='function.mssql-query.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'>query</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A SQL query. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MS SQL link identifier, returned by <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> or <a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function'>mssql_pconnect()</a>. </p> <p class='para'> If the link identifier isn&amp;#039;t specified, the last opened link is assumed. If no link is open, the function tries to establish a link as if <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> was called, and use it. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>batch_size</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The number of records to batch in the buffer. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-query.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a MS SQL result resource on success, <b><tt class='constant'>TRUE</tt></b> if no rows were returned, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mssql-query.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_query()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>);<br /><br />if(!</span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>||&amp;nbsp;!</span><span style='color: #0000BB'>mssql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'php'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;connect&amp;nbsp;or&amp;nbsp;select&amp;nbsp;database!'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;a&amp;nbsp;simple&amp;nbsp;query,&amp;nbsp;select&amp;nbsp;the&amp;nbsp;version&amp;nbsp;of&amp;nbsp;<br />//&amp;nbsp;MSSQL&amp;nbsp;and&amp;nbsp;print&amp;nbsp;it.<br /></span><span style='color: #0000BB'>$version&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;@@VERSION'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$version</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>];<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Clean&amp;nbsp;up<br /></span><span style='color: #0000BB'>mssql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$version</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-query.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If the query returns multiple results then it is necessary to fetch all results by <a href='http://www.php.net/manual/en/function.mssql-next-result.php' class='function'>mssql_next_result()</a> or free the results by <a href='http://www.php.net/manual/en/function.mssql-free-result.php' class='function'>mssql_free_result()</a> before executing next query. <br /> </p></blockquote> </div> <a name='function.mssql-query.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-select-db.php' class='function' rel='rdfs-seeAlso'>mssql_select_db()</a> - Select MS SQL database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function' rel='rdfs-seeAlso'>mssql_connect()</a> - Open MS SQL server connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_pconnect" value="<div id='function.mssql-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-pconnect.php'>mssql_pconnect</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_pconnect</span> &amp;mdash; <span class='dc-title'>Open persistent MS SQL connection</span></p> </div> <a name='function.mssql-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>mssql_pconnect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$servername</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$new_link</tt></span> ]]]] )</div> <p class='para rdfs-comment'> <b>mssql_pconnect()</b> acts very much like <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a> with two major differences. </p> <p class='para'> First, when connecting, the function would first try to find a (persistent) link that&amp;#039;s already open with the same host, username and password. If one is found, an identifier for it will be returned instead of opening a new connection. </p> <p class='para'> Second, the connection to the SQL server will not be closed when the execution of the script ends. Instead, the link will remain open for future use (<a href='http://www.php.net/manual/en/function.mssql-close.php' class='function'>mssql_close()</a> will not close links established by <b>mssql_pconnect()</b>). </p> <p class='para'> This type of links is therefore called &amp;#039;persistent&amp;#039;. </p> </div> <a name='function.mssql-pconnect.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'>servername</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MS SQL server. It can also include a port number. e.g. <i>hostname:port</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>new_link</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If a second call is made to <b>mssql_pconnect()</b> with the same arguments, no new link will be established, but instead, the link identifier of the already opened link will be returned. This parameter modifies this behavior and makes <b>mssql_pconnect()</b> always open a new link, even if <b>mssql_pconnect()</b> was called before with the same parameters. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a positive MS SQL persistent link identifier on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mssql-pconnect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_pconnect()</b> using the <i><tt class='parameter'>new_link</tt></i> parameter</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;the&amp;nbsp;database&amp;nbsp;server<br /></span><span style='color: #0000BB'>$link1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;link<br /></span><span style='color: #0000BB'>$link2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'random'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_num_rows" value="<div id='function.mssql-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-num-rows.php'>mssql_num_rows</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_num_rows</span> &amp;mdash; <span class='dc-title'>Gets the number of rows in result</span></p> </div> <a name='function.mssql-num-rows.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_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_num_rows()</b> returns the number of rows in a result set. </p> </div> <a name='function.mssql-num-rows.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows, as an integer. </p> </div> <a name='function.mssql-num-rows.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_num_rows()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL&amp;nbsp;and&amp;nbsp;select&amp;nbsp;the&amp;nbsp;database<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Select&amp;nbsp;all&amp;nbsp;our&amp;nbsp;records&amp;nbsp;from&amp;nbsp;a&amp;nbsp;table<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Total&amp;nbsp;records&amp;nbsp;in&amp;nbsp;database:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Clean&amp;nbsp;up<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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-num-rows.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-query.php' class='function' rel='rdfs-seeAlso'>mssql_query()</a> - Send MS SQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_row()</a> - Get row as enumerated array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_num_fields" value="<div id='function.mssql-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-num-fields.php'>mssql_num_fields</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_num_fields</span> &amp;mdash; <span class='dc-title'>Gets the number of fields in result</span></p> </div> <a name='function.mssql-num-fields.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_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_num_fields()</b> returns the number of fields in a result set. </p> </div> <a name='function.mssql-num-fields.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of fields, as an integer. </p> </div> <a name='function.mssql-num-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_num_fields()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;some&amp;nbsp;data&amp;nbsp;from&amp;nbsp;our&amp;nbsp;database<br /></span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[name],&amp;nbsp;[age]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Construct&amp;nbsp;a&amp;nbsp;table<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border='1'&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$header&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Iterate&amp;nbsp;through&amp;nbsp;returned&amp;nbsp;results<br /></span><span style='color: #007700'>while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Build&amp;nbsp;the&amp;nbsp;table&amp;nbsp;header<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$header</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;thead&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;&amp;lt;=&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ucfirst</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>])&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/thead&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tbody&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$header&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Build&amp;nbsp;the&amp;nbsp;row<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$value&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Close&amp;nbsp;table<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tbody&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Clean&amp;nbsp;up<br /></span><span style='color: #0000BB'>mssql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$data</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-num-fields.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-query.php' class='function' rel='rdfs-seeAlso'>mssql_query()</a> - Send MS SQL query</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-field.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_field()</a> - Get field information</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-num-rows.php' class='function' rel='rdfs-seeAlso'>mssql_num_rows()</a> - Gets the number of rows in result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_next_result" value="<div id='function.mssql-next-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-next-result.php'>mssql_next_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_next_result</span> &amp;mdash; <span class='dc-title'>Move the internal result pointer to the next result</span></p> </div> <a name='function.mssql-next-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_next_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> When sending more than one SQL statement to the server or executing a stored procedure with multiple results, it will cause the server to return multiple result sets. This function will test for additional results available form the server. If an additional result set exists it will free the existing result set and prepare to fetch the rows from the new result set. </p> </div> <a name='function.mssql-next-result.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_id</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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-next-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if an additional result set was available or <b><tt class='constant'>FALSE</tt></b> otherwise. </p> </div> <a name='function.mssql-next-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_next_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[name],&amp;nbsp;[age]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Iterate&amp;nbsp;through&amp;nbsp;returned&amp;nbsp;records<br /></span><span style='color: #007700'>do<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Handle&amp;nbsp;record&amp;nbsp;...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>}<br />}<br />while(</span><span style='color: #0000BB'>mssql_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Clean&amp;nbsp;up<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'>mssql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_min_message_severity" value="<div id='function.mssql-min-message-severity' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-min-message-severity.php'>mssql_min_message_severity</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_min_message_severity</span> &amp;mdash; <span class='dc-title'>Sets the minimum message severity</span></p> </div> <a name='function.mssql-min-message-severity.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mssql_min_message_severity</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$severity</tt></span> )</div> <p class='para rdfs-comment'> Sets the minimum message severity. </p> </div> <a name='function.mssql-min-message-severity.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'>severity</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new message severity. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-min-message-severity.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.mssql-min-message-severity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_min_message_severity()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;minimum&amp;nbsp;message&amp;nbsp;severity&amp;nbsp;to&amp;nbsp;17,&amp;nbsp;this&amp;nbsp;<br />//&amp;nbsp;will&amp;nbsp;not&amp;nbsp;show&amp;nbsp;any&amp;nbsp;messages&amp;nbsp;issued&amp;nbsp;by&amp;nbsp;the&amp;nbsp;underlaying<br />//&amp;nbsp;API&amp;nbsp;when&amp;nbsp;we&amp;nbsp;select&amp;nbsp;a&amp;nbsp;non-existent&amp;nbsp;database&amp;nbsp;below<br /></span><span style='color: #0000BB'>mssql_min_message_severity</span><span style='color: #007700'>(</span><span style='color: #0000BB'>17</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;a&amp;nbsp;non-existent&amp;nbsp;database<br /></span><span style='color: #0000BB'>mssql_select_db</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'THIS_DATABASE_DOES_NOT_EXISTS'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> mssql_select_db(): Unable to select database: THIS_DATABASE_DOES_NOT_EXISTS </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_min_error_severity" value="<div id='function.mssql-min-error-severity' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-min-error-severity.php'>mssql_min_error_severity</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_min_error_severity</span> &amp;mdash; <span class='dc-title'>Sets the minimum error severity</span></p> </div> <a name='function.mssql-min-error-severity.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><span class='type void'>void</span></span> <span class='methodname'><b>mssql_min_error_severity</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$severity</tt></span> )</div> <p class='para rdfs-comment'> Sets the minimum error severity. </p> </div> <a name='function.mssql-min-error-severity.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'>severity</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new error severity. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-min-error-severity.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> No value is returned. </p> </div> <a name='function.mssql-min-error-severity.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_min_error_severity()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Set&amp;nbsp;the&amp;nbsp;minimum&amp;nbsp;error&amp;nbsp;severity&amp;nbsp;to&amp;nbsp;not&amp;nbsp;include&amp;nbsp;SQL&amp;nbsp;<br />//&amp;nbsp;syntax&amp;nbsp;errors&amp;nbsp;by&amp;nbsp;setting&amp;nbsp;it&amp;nbsp;to&amp;nbsp;something&amp;nbsp;greater&amp;nbsp;than&amp;nbsp;<br />//&amp;nbsp;or&amp;nbsp;equal&amp;nbsp;to&amp;nbsp;1.<br /></span><span style='color: #0000BB'>mssql_min_error_severity</span><span style='color: #007700'>(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;query&amp;nbsp;we&amp;nbsp;know&amp;nbsp;that&amp;nbsp;will&amp;nbsp;cause&amp;nbsp;an&amp;nbsp;syntax&amp;nbsp;error,&amp;nbsp;in<br />//&amp;nbsp;this&amp;nbsp;case&amp;nbsp;we&amp;nbsp;use&amp;nbsp;the&amp;nbsp;MySQL&amp;nbsp;quote&amp;nbsp;signs&amp;nbsp;instead&amp;nbsp;of&amp;nbsp;wrapping&amp;nbsp;<br />//&amp;nbsp;square&amp;nbsp;brackets&amp;nbsp;around&amp;nbsp;the&amp;nbsp;field&amp;nbsp;and&amp;nbsp;table&amp;nbsp;names.<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;`syntax`,&amp;nbsp;`error`&amp;nbsp;FROM&amp;nbsp;`MSSQL`'</span><span style='color: #007700'>);<br /><br />if(!</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Custom&amp;nbsp;error&amp;nbsp;handler&amp;nbsp;...<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_init" value="<div id='function.mssql-init' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-init.php'>mssql_init</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_init</span> &amp;mdash; <span class='dc-title'>Initializes a stored procedure or a remote stored procedure</span></p> </div> <a name='function.mssql-init.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>mssql_init</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sp_name</tt></span> [, <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Initializes a stored procedure or a remote stored procedure. </p> </div> <a name='function.mssql-init.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'>sp_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Stored procedure name, like <i>ownew.sp_name</i> or <i>otherdb.owner.sp_name</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MS SQL link identifier, returned by <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-init.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a resource identifier &amp;quot;statement&amp;quot;, used in subsequent calls to <a href='http://www.php.net/manual/en/function.mssql-bind.php' class='function'>mssql_bind()</a> and <a href='http://www.php.net/manual/en/function.mssql-execute.php' class='function'>mssql_execute()</a>, or <b><tt class='constant'>FALSE</tt></b> on errors. </p> </div> <a name='function.mssql-init.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_init()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;statement<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'StatementTest'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bind&amp;nbsp;values&amp;nbsp;here<br /><br />//&amp;nbsp;Once&amp;nbsp;values&amp;nbsp;are&amp;nbsp;binded&amp;nbsp;we&amp;nbsp;execute&amp;nbsp;our&amp;nbsp;statement&amp;nbsp;<br />//&amp;nbsp;using&amp;nbsp;mssql_execute:<br /></span><span style='color: #0000BB'>mssql_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;And&amp;nbsp;we&amp;nbsp;can&amp;nbsp;free&amp;nbsp;it&amp;nbsp;like&amp;nbsp;so:<br /></span><span style='color: #0000BB'>mssql_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-init.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-bind.php' class='function' rel='rdfs-seeAlso'>mssql_bind()</a> - Adds a parameter to a stored procedure or a remote stored procedure</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-execute.php' class='function' rel='rdfs-seeAlso'>mssql_execute()</a> - Executes a stored procedure on a MS SQL server database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-free-statement.php' class='function' rel='rdfs-seeAlso'>mssql_free_statement()</a> - Free statement memory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_guid_string" value="<div id='function.mssql-guid-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-guid-string.php'>mssql_guid_string</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_guid_string</span> &amp;mdash; <span class='dc-title'>Converts a 16 byte binary GUID to a string</span></p> </div> <a name='function.mssql-guid-string.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mssql_guid_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$binary</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$short_format</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Converts a 16 byte binary GUID to a string. </p> </div> <a name='function.mssql-guid-string.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'>binary</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A 16 byte binary GUID. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>short_format</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whenever to use short to use short format, defaults to <b><tt class='constant'>FALSE</tt></b> </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-guid-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the converted string on success. </p> </div> <a name='function.mssql-guid-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_guid_string()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$binary&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'19555081977808608437941339997619274330352755554827939936'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>mssql_guid_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$binary</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>mssql_guid_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$binary</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>));<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> string(36) &amp;quot;35353931-3035-3138-3937-373830383630&amp;quot; string(32) &amp;quot;31393535353038313937373830383630&amp;quot; </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_get_last_message" value="<div id='function.mssql-get-last-message' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-get-last-message.php'>mssql_get_last_message</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_get_last_message</span> &amp;mdash; <span class='dc-title'>Returns the last message from the server</span></p> </div> <a name='function.mssql-get-last-message.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mssql_get_last_message</b></span> ( <span class='methodparam'>void</span> )</div> <p class='para rdfs-comment'> Gets the last message from the MS-SQL server </p> </div> <a name='function.mssql-get-last-message.parameters'></a><div class='refsect1 parameters'> <h3 class='title'>Parameters</h3> <p class='para'>This function has no parameters.</p> </div> <a name='function.mssql-get-last-message.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns last error message from server, or an empty string if no error messages are returned from MSSQL. </p> </div> <a name='function.mssql-get-last-message.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_get_last_message()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Make&amp;nbsp;a&amp;nbsp;query&amp;nbsp;that&amp;nbsp;will&amp;nbsp;fail<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[not-found]'</span><span style='color: #007700'>);<br /><br />if(!</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;The&amp;nbsp;query&amp;nbsp;has&amp;nbsp;failed,&amp;nbsp;print&amp;nbsp;a&amp;nbsp;nice&amp;nbsp;error&amp;nbsp;message<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;using&amp;nbsp;mssql_get_last_message()<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>die(</span><span style='color: #DD0000'>'MSSQL&amp;nbsp;error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_get_last_message</span><span style='color: #007700'>());<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</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> MSSQL error: Invalid object name &amp;#039;php.dbo.not-found&amp;#039;. </pre></div> </div> </div><p> </p> </div> <a name='function.mssql-get-last-message.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-min-error-severity.php' class='function' rel='rdfs-seeAlso'>mssql_min_error_severity()</a> - Sets the minimum error severity</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-min-message-severity.php' class='function' rel='rdfs-seeAlso'>mssql_min_message_severity()</a> - Sets the minimum message severity</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_free_statement" value="<div id='function.mssql-free-statement' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-free-statement.php'>mssql_free_statement</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.3.2, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_free_statement</span> &amp;mdash; <span class='dc-title'>Free statement memory</span></p> </div> <a name='function.mssql-free-statement.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_free_statement</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_free_statement()</b> only needs to be called if you are worried about using too much memory while your script is running. All statement memory will automatically be freed when the script ends. You may call <b>mssql_free_statement()</b> with the statement identifier as an argument and the associated statement memory will be freed. </p> </div> <a name='function.mssql-free-statement.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Statement resource, obtained with <a href='http://www.php.net/manual/en/function.mssql-init.php' class='function'>mssql_init()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-free-statement.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-free-statement.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_free_statement()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;statement<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'test'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bind&amp;nbsp;values&amp;nbsp;here&amp;nbsp;and&amp;nbsp;execute&amp;nbsp;the&amp;nbsp;statement<br /><br />//&amp;nbsp;once&amp;nbsp;we're&amp;nbsp;done,&amp;nbsp;we&amp;nbsp;clear&amp;nbsp;it&amp;nbsp;from&amp;nbsp;the&amp;nbsp;memory<br />//&amp;nbsp;using&amp;nbsp;mssql_free_statement&amp;nbsp;like&amp;nbsp;so:<br /></span><span style='color: #0000BB'>mssql_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-free-statement.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-bind.php' class='function' rel='rdfs-seeAlso'>mssql_bind()</a> - Adds a parameter to a stored procedure or a remote stored procedure</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-execute.php' class='function' rel='rdfs-seeAlso'>mssql_execute()</a> - Executes a stored procedure on a MS SQL server database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-init.php' class='function' rel='rdfs-seeAlso'>mssql_init()</a> - Initializes a stored procedure or a remote stored procedure</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-free-result.php' class='function' rel='rdfs-seeAlso'>mssql_free_result()</a> - Free result memory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_free_result" value="<div id='function.mssql-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-free-result.php'>mssql_free_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_free_result</span> &amp;mdash; <span class='dc-title'>Free result memory</span></p> </div> <a name='function.mssql-free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_free_result()</b> only needs to be called if you are worried about using too much memory while your script is running. All result memory will automatically be freed when the script ends. You may call <b>mssql_free_result()</b> with the result identifier as an argument and the associated result memory will be freed. </p> </div> <a name='function.mssql-free-result.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 freed. This result comes from a call to <a href='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-free-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_free_result()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;some&amp;nbsp;data&amp;nbsp;from&amp;nbsp;a&amp;nbsp;table<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Handle&amp;nbsp;query&amp;nbsp;result&amp;nbsp;here<br /><br />//&amp;nbsp;When&amp;nbsp;we're&amp;nbsp;done&amp;nbsp;we&amp;nbsp;free&amp;nbsp;the&amp;nbsp;result&amp;nbsp;by&amp;nbsp;calling<br />//&amp;nbsp;mssql_free_result&amp;nbsp;like&amp;nbsp;so:<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'>);</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-free-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-free-statement.php' class='function' rel='rdfs-seeAlso'>mssql_free_statement()</a> - Free statement memory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_field_type" value="<div id='function.mssql-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-field-type.php'>mssql_field_type</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_field_type</span> &amp;mdash; <span class='dc-title'>Gets the type of a field</span></p> </div> <a name='function.mssql-field-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mssql_field_type</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 type 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-type.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='http://www.php.net/manual/en/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-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The type of the specified field index on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-field-type.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_type()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;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'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[name]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;the&amp;nbsp;field&amp;nbsp;type&amp;nbsp;and&amp;nbsp;length<br /></span><span style='color: #007700'>echo&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'\''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\'&amp;nbsp;is&amp;nbsp;a&amp;nbsp;type&amp;nbsp;of&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>mssql_field_type</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>))&amp;nbsp;.&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_field_length</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</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> &amp;#039;name&amp;#039; is a type of CHAR(50) </pre></div> </div> </div><p> </p> </div> <a name='function.mssql-field-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-field-length.php' class='function' rel='rdfs-seeAlso'>mssql_field_length()</a> - Get the length of a field</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-field-name.php' class='function' rel='rdfs-seeAlso'>mssql_field_name()</a> - Get the name of a field</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_field_seek" value="<div id='function.mssql-field-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-field-seek.php'>mssql_field_seek</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_field_seek</span> &amp;mdash; <span class='dc-title'>Seeks to the specified field offset</span></p> </div> <a name='function.mssql-field-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_field_seek</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'>$field_offset</tt></span> )</div> <p class='para rdfs-comment'> Seeks to the specified field offset. If the next call to <a href='http://www.php.net/manual/en/function.mssql-fetch-field.php' class='function'>mssql_fetch_field()</a> won&amp;#039;t include a field offset, this field would be returned. </p> </div> <a name='function.mssql-field-seek.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The field offset, starts at 0. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-field-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-field-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using <b>mssql_field_seek()</b> on the example for <a href='http://www.php.net/manual/en/function.mssql-fetch-field.php' class='function'>mssql_fetch_field()</a></b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;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'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Construct&amp;nbsp;table<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;h3&amp;gt;Table&amp;nbsp;structure&amp;nbsp;for&amp;nbsp;\'persons\'&amp;lt;/h3&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border='1'&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Table&amp;nbsp;header<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;thead&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Field&amp;nbsp;name&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Data&amp;nbsp;type&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Max&amp;nbsp;length&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/thead&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Dump&amp;nbsp;all&amp;nbsp;fields<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tbody&amp;gt;'</span><span style='color: #007700'>;<br /><br />for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;the&amp;nbsp;field&amp;nbsp;information,&amp;nbsp;notice&amp;nbsp;the&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;field_offset&amp;nbsp;parameter&amp;nbsp;is&amp;nbsp;not&amp;nbsp;set.&amp;nbsp;See&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;the&amp;nbsp;mssql_field_seek&amp;nbsp;call&amp;nbsp;below<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$field&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;the&amp;nbsp;row<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Move&amp;nbsp;the&amp;nbsp;internal&amp;nbsp;seek&amp;nbsp;pointer&amp;nbsp;to&amp;nbsp;the&amp;nbsp;next<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;row&amp;nbsp;in&amp;nbsp;the&amp;nbsp;result&amp;nbsp;set<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>mssql_field_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tbody&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-field-seek.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-field.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_field()</a> - Get field information</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_field_name" value="<div id='function.mssql-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-field-name.php'>mssql_field_name</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_field_name</span> &amp;mdash; <span class='dc-title'>Get the name of a field</span></p> </div> <a name='function.mssql-field-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>mssql_field_name</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 name 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-name.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='http://www.php.net/manual/en/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-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> The name of the specified field index on success, or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-field-name.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_name()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username],&amp;nbsp;[name],&amp;nbsp;[email]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Result&amp;nbsp;set&amp;nbsp;contains&amp;nbsp;the&amp;nbsp;following&amp;nbsp;field(s):'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Dump&amp;nbsp;all&amp;nbsp;field&amp;nbsp;names&amp;nbsp;in&amp;nbsp;result<br /></span><span style='color: #007700'>for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;-&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_field_name</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>),&amp;nbsp;</span><span style='color: #0000BB'>PHP_EOL</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</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> Result set contains the following field(s): - username - name - email </pre></div> </div> </div><p> </p> </div> <a name='function.mssql-field-name.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-field-length.php' class='function' rel='rdfs-seeAlso'>mssql_field_length()</a> - Get the length of a field</li> <li class='member'><a href='http://www.php.net/manual/en/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><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_field_length" value="<div id='function.mssql-field-length' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-field-length.php'>mssql_field_length</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_field_length</span> &amp;mdash; <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='http://www.php.net/manual/en/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'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;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'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[name],&amp;nbsp;[age]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;the&amp;nbsp;field&amp;nbsp;type&amp;nbsp;and&amp;nbsp;length<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;field&amp;nbsp;\'age\'&amp;nbsp;has&amp;nbsp;a&amp;nbsp;data&amp;nbsp;length&amp;nbsp;of&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_field_length</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</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 &amp;#039;age&amp;#039; 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='http://www.php.net/manual/en/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='http://www.php.net/manual/en/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><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_row" value="<div id='function.mssql-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-row.php'>mssql_fetch_row</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_row</span> &amp;mdash; <span class='dc-title'>Get row as enumerated array</span></p> </div> <a name='function.mssql-fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mssql_fetch_row</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_fetch_row()</b> fetches one row of data from the result associated with the specified result identifier. The row is returned as an array. Each result column is stored in an array offset, starting at offset 0. </p> <p class='para'> Subsequent call to <b>mssql_fetch_row()</b> would return the next row in the result set, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.mssql-fetch-row.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.mssql-fetch-row.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_row()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;server&amp;nbsp;and&amp;nbsp;database<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Query&amp;nbsp;to&amp;nbsp;execute<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[id],&amp;nbsp;[quote]&amp;nbsp;FROM&amp;nbsp;[quotes]&amp;nbsp;WHERE&amp;nbsp;[id]&amp;nbsp;=&amp;nbsp;\'42\''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Did&amp;nbsp;the&amp;nbsp;query&amp;nbsp;failed?<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'MSSQL&amp;nbsp;error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>mssql_get_last_message</span><span style='color: #007700'>());<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;the&amp;nbsp;row<br /></span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;the&amp;nbsp;'quote'<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'Quote&amp;nbsp;#'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>':&amp;nbsp;''&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'''</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</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> Quote #42: &amp;quot;The answer to everything...&amp;quot; </pre></div> </div> </div><p> </p> </div> <a name='function.mssql-fetch-row.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mssql-fetch-row.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-object.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_object()</a> - Fetch row as object</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-data-seek.php' class='function' rel='rdfs-seeAlso'>mssql_data_seek()</a> - Moves internal row pointer</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-result.php' class='function' rel='rdfs-seeAlso'>mssql_result()</a> - Get result data</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_object" value="<div id='function.mssql-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-object.php'>mssql_fetch_object</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_object</span> &amp;mdash; <span class='dc-title'>Fetch row as object</span></p> </div> <a name='function.mssql-fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mssql_fetch_object</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_fetch_object()</b> is similar to <a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function'>mssql_fetch_array()</a>, with one difference - an object is returned, instead of an array. Indirectly, that means that you can only access the data by the field names, and not by their offsets (numbers are illegal property names). </p> <p class='para'> Speed-wise, the function is identical to <a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function'>mssql_fetch_array()</a>, and almost as quick as <a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function'>mssql_fetch_row()</a> (the difference is insignificant). </p> </div> <a name='function.mssql-fetch-object.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object with properties that correspond to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.mssql-fetch-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_object()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username],&amp;nbsp;[name]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;were&amp;nbsp;any&amp;nbsp;records<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;records&amp;nbsp;found'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;a&amp;nbsp;nice&amp;nbsp;list&amp;nbsp;of&amp;nbsp;users&amp;nbsp;in&amp;nbsp;the&amp;nbsp;format&amp;nbsp;of:<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;*&amp;nbsp;name&amp;nbsp;(username)<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;ul&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;li&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>username&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>')&amp;lt;/li&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/ul&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-fetch-object.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mssql-fetch-object.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_array()</a> - Fetch a result row as an associative array, a numeric array, or both</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_row()</a> - Get row as enumerated array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_field" value="<div id='function.mssql-fetch-field' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-field.php'>mssql_fetch_field</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_field</span> &amp;mdash; <span class='dc-title'>Get field information</span></p> </div> <a name='function.mssql-fetch-field.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>mssql_fetch_field</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'>$field_offset</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> <b>mssql_fetch_field()</b> can be used in order to obtain information about fields in a certain query result. </p> </div> <a name='function.mssql-fetch-field.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>field_offset</tt></i> </span> </dt><dd class='listitem'> <p class='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 <i><tt class='parameter'>field_offset</tt></i> starts at 0. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-field.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object containing field information. </p> <p class='para'> The properties of the object are: </p> <ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> name - column name. if the column is a result of a function, this property is set to computed#N, where #N is a serial number. </span> </li> <li class='listitem'> <span class='simpara'> column_source - the table from which the column was taken </span> </li> <li class='listitem'> <span class='simpara'> max_length - maximum length of the column </span> </li> <li class='listitem'> <span class='simpara'> numeric - 1 if the column is numeric </span> </li> <li class='listitem'> <span class='simpara'> type - the column type. </span> </li> </ul> </div> <a name='function.mssql-fetch-field.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_field()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;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'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[persons]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Construct&amp;nbsp;table<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;h3&amp;gt;Table&amp;nbsp;structure&amp;nbsp;for&amp;nbsp;\'persons\'&amp;lt;/h3&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;table&amp;nbsp;border='1'&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Table&amp;nbsp;header<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;thead&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Field&amp;nbsp;name&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Data&amp;nbsp;type&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;Max&amp;nbsp;length&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/thead&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Dump&amp;nbsp;all&amp;nbsp;fields<br /></span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tbody&amp;gt;'</span><span style='color: #007700'>;<br /><br />for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);&amp;nbsp;++</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;the&amp;nbsp;field&amp;nbsp;information<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$field&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_field</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;the&amp;nbsp;row<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;tr&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>name&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>strtoupper</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>type</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;td&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$field</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>max_length&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/td&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tr&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/tbody&amp;gt;'</span><span style='color: #007700'>;<br />echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/table&amp;gt;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-fetch-field.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-field-seek.php' class='function' rel='rdfs-seeAlso'>mssql_field_seek()</a> - Seeks to the specified field offset</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_batch" value="<div id='function.mssql-fetch-batch' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-batch.php'>mssql_fetch_batch</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_batch</span> &amp;mdash; <span class='dc-title'>Returns the next batch of records</span></p> </div> <a name='function.mssql-fetch-batch.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_fetch_batch</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <p class='para rdfs-comment'> Returns the next batch of records </p> </div> <a name='function.mssql-fetch-batch.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-batch.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the batch number as an integer. </p> </div> <a name='function.mssql-fetch-batch.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_batch()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;query<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[people]'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$records&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>10</span><span style='color: #007700'>;<br /><br />while(</span><span style='color: #0000BB'>$records&amp;nbsp;</span><span style='color: #007700'>&amp;gt;=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;stuff&amp;nbsp;...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;--</span><span style='color: #0000BB'>$records</span><span style='color: #007700'>;<br />}<br /><br />if(</span><span style='color: #0000BB'>$batchsize&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_batch</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;$batchsize&amp;nbsp;is&amp;nbsp;the&amp;nbsp;number&amp;nbsp;of&amp;nbsp;records&amp;nbsp;left&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;in&amp;nbsp;the&amp;nbsp;result,&amp;nbsp;but&amp;nbsp;not&amp;nbsp;shown&amp;nbsp;above<br /></span><span style='color: #007700'>}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_assoc" value="<div id='function.mssql-fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-assoc.php'>mssql_fetch_assoc</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_assoc</span> &amp;mdash; <span class='dc-title'>Returns an associative array of the current row in the result</span></p> </div> <a name='function.mssql-fetch-assoc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mssql_fetch_assoc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_id</tt></span> )</div> <p class='para rdfs-comment'> Returns an associative array that corresponds to the fetched row and moves the internal data pointer ahead. <b>mssql_fetch_assoc()</b> is equivalent to calling <a href='http://www.php.net/manual/en/function.mssql-fetch-array.php' class='function'>mssql_fetch_array()</a> with <b><tt class='constant'>MSSQL_ASSOC</tt></b> for the optional second parameter. </p> </div> <a name='function.mssql-fetch-assoc.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_id</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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-assoc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_assoc()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username],&amp;nbsp;[name]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;were&amp;nbsp;any&amp;nbsp;records<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;records&amp;nbsp;found'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Print&amp;nbsp;a&amp;nbsp;nice&amp;nbsp;list&amp;nbsp;of&amp;nbsp;users&amp;nbsp;in&amp;nbsp;the&amp;nbsp;format&amp;nbsp;of:<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;*&amp;nbsp;name&amp;nbsp;(username)<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;ul&amp;gt;'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;li&amp;gt;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;('&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'username'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>')&amp;lt;/li&amp;gt;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;/ul&amp;gt;'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_fetch_array" value="<div id='function.mssql-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-fetch-array.php'>mssql_fetch_array</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_fetch_array</span> &amp;mdash; <span class='dc-title'>Fetch a result row as an associative array, a numeric array, or both</span></p> </div> <a name='function.mssql-fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>mssql_fetch_array</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'>$result_type</tt><span class='initializer'> = MSSQL_BOTH</span></span> ] )</div> <p class='para rdfs-comment'> <b>mssql_fetch_array()</b> is an extended version of <a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function'>mssql_fetch_row()</a>. In addition to storing the data in the numeric indices of the result array, it also stores the data in associative indices, using the field names as keys. </p> <p class='para'> An important thing to note is that using <b>mssql_fetch_array()</b> is NOT significantly slower than using <a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function'>mssql_fetch_row()</a>, while it provides a significant added value. </p> </div> <a name='function.mssql-fetch-array.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='http://www.php.net/manual/en/function.mssql-query.php' class='function'>mssql_query()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The type of array that is to be fetched. It&amp;#039;s a constant and can take the following values: <b><tt class='constant'>MSSQL_ASSOC</tt></b>, <b><tt class='constant'>MSSQL_NUM</tt></b>, and the default value of <b><tt class='constant'>MSSQL_BOTH</tt></b>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array that corresponds to the fetched row, or <b><tt class='constant'>FALSE</tt></b> if there are no more rows. </p> </div> <a name='function.mssql-fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_fetch_array()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Send&amp;nbsp;a&amp;nbsp;select&amp;nbsp;query&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[username],&amp;nbsp;[name]&amp;nbsp;FROM&amp;nbsp;[php].[dbo].[userlist]'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;there&amp;nbsp;were&amp;nbsp;any&amp;nbsp;records<br /></span><span style='color: #007700'>if(!</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>))<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;records&amp;nbsp;found'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;The&amp;nbsp;following&amp;nbsp;is&amp;nbsp;equal&amp;nbsp;to&amp;nbsp;the&amp;nbsp;code&amp;nbsp;below:<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//&amp;nbsp;while($row&amp;nbsp;=&amp;nbsp;mssql_fetch_row($query))<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>MSSQL_NUM</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;...<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>}<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;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'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-fetch-array.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>Field names returned by this function are <em class='emphasis'>case-sensitive</em>.</span></p></blockquote> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function sets NULL fields to the PHP <b><tt class='constant'>NULL</tt></b> value.</span></p></blockquote> </div> <a name='function.mssql-fetch-array.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function' rel='rdfs-seeAlso'>mssql_fetch_row()</a> - Get row as enumerated array</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_execute" value="<div id='function.mssql-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-execute.php'>mssql_execute</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_execute</span> &amp;mdash; <span class='dc-title'>Executes a stored procedure on a MS SQL server database</span></p> </div> <a name='function.mssql-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>mssql_execute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$skip_results</tt><span class='initializer'> = false</span></span> ] )</div> <p class='para rdfs-comment'> Executes a stored procedure on a MS SQL server database </p> </div> <a name='function.mssql-execute.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Statement handle obtained with <a href='http://www.php.net/manual/en/function.mssql-init.php' class='function'>mssql_init()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>skip_results</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whenever to skip the results or not. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_execute()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;statement<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'NewBlogEntry'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Some&amp;nbsp;data&amp;nbsp;strings<br /></span><span style='color: #0000BB'>$title&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Test&amp;nbsp;of&amp;nbsp;blogging&amp;nbsp;system'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$content&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'If&amp;nbsp;you&amp;nbsp;can&amp;nbsp;read&amp;nbsp;this,&amp;nbsp;then&amp;nbsp;the&amp;nbsp;new&amp;nbsp;system&amp;nbsp;is&amp;nbsp;compatible&amp;nbsp;with&amp;nbsp;MSSQL'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bind&amp;nbsp;values<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@author'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'Felipe&amp;nbsp;Pena'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLVARCHAR</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@date'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'08/10/2008'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLVARCHAR</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>20</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@title'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$title</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLVARCHAR</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@content'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$content</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLTEXT</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;the&amp;nbsp;statement<br /></span><span style='color: #0000BB'>mssql_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;And&amp;nbsp;we&amp;nbsp;can&amp;nbsp;free&amp;nbsp;it&amp;nbsp;like&amp;nbsp;so:<br /></span><span style='color: #0000BB'>mssql_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-execute.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: If the stored procedure returns parameters or a return value these will be available after the call to <b>mssql_execute()</b> unless the stored procedure returns more than one result set. In that case use <a href='http://www.php.net/manual/en/function.mssql-next-result.php' class='function'>mssql_next_result()</a> to shift through the results. When the last result has been processed the output parameters and return values will be available. <br /> </p></blockquote> </div> <a name='function.mssql-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-bind.php' class='function' rel='rdfs-seeAlso'>mssql_bind()</a> - Adds a parameter to a stored procedure or a remote stored procedure</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-free-statement.php' class='function' rel='rdfs-seeAlso'>mssql_free_statement()</a> - Free statement memory</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-init.php' class='function' rel='rdfs-seeAlso'>mssql_init()</a> - Initializes a stored procedure or a remote stored procedure</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_data_seek" value="<div id='function.mssql-data-seek' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-data-seek.php'>mssql_data_seek</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_data_seek</span> &amp;mdash; <span class='dc-title'>Moves internal row pointer</span></p> </div> <a name='function.mssql-data-seek.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_data_seek</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_identifier</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt></span> )</div> <p class='para rdfs-comment'> <b>mssql_data_seek()</b> moves the internal row pointer of the MS SQL result associated with the specified result identifier to point to the specified row number, first row being number 0. The next call to <a href='http://www.php.net/manual/en/function.mssql-fetch-row.php' class='function'>mssql_fetch_row()</a> would return that row. </p> </div> <a name='function.mssql-data-seek.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_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The result resource that is being evaluated. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The desired row number of the new result pointer. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-data-seek.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-data-seek.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_data_seek()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'MANGO\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>,&amp;nbsp;</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;all&amp;nbsp;people<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_query</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SELECT&amp;nbsp;[name],&amp;nbsp;[age]&amp;nbsp;FROM&amp;nbsp;[persons]&amp;nbsp;WHERE&amp;nbsp;[age]&amp;nbsp;&amp;gt;=&amp;nbsp;13'</span><span style='color: #007700'>);<br /><br />if(!</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Query&amp;nbsp;failed.'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Select&amp;nbsp;every&amp;nbsp;4th&amp;nbsp;student&amp;nbsp;in&amp;nbsp;the&amp;nbsp;results<br /></span><span style='color: #007700'>for(</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_num_rows</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;-&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>%&amp;nbsp;</span><span style='color: #0000BB'>4</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(!</span><span style='color: #0000BB'>mssql_data_seek</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>))<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;continue;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Fetch&amp;nbsp;the&amp;nbsp;row&amp;nbsp;...<br /></span><span style='color: #007700'>}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;the&amp;nbsp;query&amp;nbsp;result<br /></span><span style='color: #0000BB'>mssql_free_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_connect" value="<div id='function.mssql-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-connect.php'>mssql_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_connect</span> &amp;mdash; <span class='dc-title'>Open MS SQL server connection</span></p> </div> <a name='function.mssql-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>mssql_connect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$servername</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$new_link</tt></span> ]]]] )</div> <p class='para rdfs-comment'> <b>mssql_connect()</b> establishes a connection to a MS SQL server. </p> <p class='para'> The link to the server will be closed as soon as the execution of the script ends, unless it&amp;#039;s closed earlier by explicitly calling <a href='http://www.php.net/manual/en/function.mssql-close.php' class='function'>mssql_close()</a>. </p> </div> <a name='function.mssql-connect.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'>servername</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The MS SQL server. It can also include a port number. e.g. <i>hostname,port</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>new_link</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If a second call is made to <b>mssql_connect()</b> with the same arguments, no new link will be established, but instead, the link identifier of the already opened link will be returned. This parameter modifies this behavior and makes <b>mssql_connect()</b> always open a new link, even if <b>mssql_connect()</b> was called before with the same parameters. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a MS SQL link identifier on success, or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.mssql-connect.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.4.1 and 5.1.0</td> <td align='left'> The <i><tt class='parameter'>new_link</tt></i> parameter was added </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.mssql-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_connect()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Server&amp;nbsp;in&amp;nbsp;the&amp;nbsp;this&amp;nbsp;format:&amp;nbsp;&amp;lt;computer&amp;gt;\&amp;lt;instance&amp;nbsp;name&amp;gt;&amp;nbsp;or&amp;nbsp;<br />//&amp;nbsp;&amp;lt;server&amp;gt;,&amp;lt;port&amp;gt;&amp;nbsp;when&amp;nbsp;using&amp;nbsp;a&amp;nbsp;non&amp;nbsp;default&amp;nbsp;port&amp;nbsp;number<br /></span><span style='color: #0000BB'>$server&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>);<br /><br />if(!</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Something&amp;nbsp;went&amp;nbsp;wrong&amp;nbsp;while&amp;nbsp;connecting&amp;nbsp;to&amp;nbsp;MSSQL'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-close.php' class='function' rel='rdfs-seeAlso'>mssql_close()</a> - Close MS SQL Server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function' rel='rdfs-seeAlso'>mssql_pconnect()</a> - Open persistent MS SQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_close" value="<div id='function.mssql-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-close.php'>mssql_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_close</span> &amp;mdash; <span class='dc-title'>Close MS SQL Server connection</span></p> </div> <a name='function.mssql-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_close</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> ] )</div> <p class='para rdfs-comment'> Closes the link to a MS SQL Server database that&amp;#039;s associated with the specified link identifier. If the link identifier isn&amp;#039;t specified, the last opened link is assumed. </p> <p class='para'> Note that this isn&amp;#039;t usually necessary, as non-persistent open links are automatically closed at the end of the script&amp;#039;s execution. </p> </div> <a name='function.mssql-close.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A MS SQL link identifier, returned by <a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function'>mssql_connect()</a>. </p> <p class='para'> This function will not close persistent links generated by <a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function'>mssql_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_close()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>$link&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'phpfi'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Do&amp;nbsp;any&amp;nbsp;related&amp;nbsp;operations&amp;nbsp;here<br /><br />//&amp;nbsp;Close&amp;nbsp;the&amp;nbsp;link&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$link</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-connect.php' class='function' rel='rdfs-seeAlso'>mssql_connect()</a> - Open MS SQL server connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-pconnect.php' class='function' rel='rdfs-seeAlso'>mssql_pconnect()</a> - Open persistent MS SQL connection</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="mssql_bind" value="<div id='function.mssql-bind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.mssql-bind.php'>mssql_bind</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.7, PHP 5, PECL odbtp &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>mssql_bind</span> &amp;mdash; <span class='dc-title'>Adds a parameter to a stored procedure or a remote stored procedure</span></p> </div> <a name='function.mssql-bind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>mssql_bind</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$param_name</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter reference'>&amp;amp;$var</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$is_output</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$is_null</tt><span class='initializer'> = false</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$maxlen</tt><span class='initializer'> = -1</span></span> ]]] )</div> <p class='para rdfs-comment'> Binds a parameter to a stored procedure or a remote stored procedure. </p> </div> <a name='function.mssql-bind.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Statement resource, obtained with <a href='http://www.php.net/manual/en/function.mssql-init.php' class='function'>mssql_init()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>param_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameter name, as a string. </p> <blockquote><p><b class='note'>Note</b>: You have to include the <i>@</i> character, like in the T-SQL syntax. See the explanation included in <a href='http://www.php.net/manual/en/function.mssql-execute.php' class='function'>mssql_execute()</a>. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>var</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The PHP variable you&amp;#039;ll bind the MSSQL parameter to. It is passed by reference, to retrieve OUTPUT and RETVAL values after the procedure execution. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of: <b><tt class='constant'>SQLTEXT</tt></b>, <b><tt class='constant'>SQLVARCHAR</tt></b>, <b><tt class='constant'>SQLCHAR</tt></b>, <b><tt class='constant'>SQLINT1</tt></b>, <b><tt class='constant'>SQLINT2</tt></b>, <b><tt class='constant'>SQLINT4</tt></b>, <b><tt class='constant'>SQLBIT</tt></b>, <b><tt class='constant'>SQLFLT4</tt></b>, <b><tt class='constant'>SQLFLT8</tt></b>, <b><tt class='constant'>SQLFLTN</tt></b>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>is_output</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether the value is an OUTPUT parameter or not. If it&amp;#039;s an OUTPUT parameter and you don&amp;#039;t mention it, it will be treated as a normal input parameter and no error will be thrown. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>is_null</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Whether the parameter is <b><tt class='constant'>NULL</tt></b> or not. Passing the <b><tt class='constant'>NULL</tt></b> value as <i><tt class='parameter'>var</tt></i> will not do the job. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>maxlen</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used with char/varchar values. You have to indicate the length of the data so if the parameter is a varchar(50), the type must be <b><tt class='constant'>SQLVARCHAR</tt></b> and this value <i>50</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.mssql-bind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.mssql-bind.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 <b>mssql_bind()</b> example</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;Connect&amp;nbsp;to&amp;nbsp;MSSQL<br /></span><span style='color: #0000BB'>mssql_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'KALLESPC\SQLEXPRESS'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sa'</span><span style='color: #007700'>,&amp;nbsp;</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'>//&amp;nbsp;Create&amp;nbsp;a&amp;nbsp;new&amp;nbsp;stored&amp;nbsp;prodecure<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>mssql_init</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'NewUserRecord'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Bind&amp;nbsp;the&amp;nbsp;field&amp;nbsp;names<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@username'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'Kalle'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLVARCHAR</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@name'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'Kalle'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLVARCHAR</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>60</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>mssql_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'@age'</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>19</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>SQLINT1</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>,&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Execute&amp;nbsp;<br /></span><span style='color: #0000BB'>mssql_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Free&amp;nbsp;statement<br /></span><span style='color: #0000BB'>mssql_free_statement</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.mssql-bind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-execute.php' class='function' rel='rdfs-seeAlso'>mssql_execute()</a> - Executes a stored procedure on a MS SQL server database</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-free-statement.php' class='function' rel='rdfs-seeAlso'>mssql_free_statement()</a> - Free statement memory</li> <li class='member'><a href='http://www.php.net/manual/en/function.mssql-init.php' class='function' rel='rdfs-seeAlso'>mssql_init()</a> - Initializes a stored procedure or a remote stored procedure</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_unbind" value="<div id='function.ldap-unbind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-unbind.php'>ldap_unbind</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_unbind</span> &amp;mdash; <span class='dc-title'>Unbind from LDAP directory</span></p> </div> <a name='function.ldap-unbind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_unbind</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> )</div> <p class='para rdfs-comment'> Unbinds from the LDAP directory. </p> </div> <a name='function.ldap-unbind.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-unbind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-unbind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-bind.php' class='function' rel='rdfs-seeAlso'>ldap_bind()</a> - Bind to LDAP directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_start_tls" value="<div id='function.ldap-start-tls' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-start-tls.php'>ldap_start_tls</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_start_tls</span> &amp;mdash; <span class='dc-title'>Start TLS</span></p> </div> <a name='function.ldap-start-tls.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_start_tls</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_sort" value="<div id='function.ldap-sort' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-sort.php'>ldap_sort</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.2.0, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_sort</span> &amp;mdash; <span class='dc-title'>Sort LDAP result entries</span></p> </div> <a name='function.ldap-sort.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_sort</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$sortfilter</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_set_option" value="<div id='function.ldap-set-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-set-option.php'>ldap_set_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_set_option</span> &amp;mdash; <span class='dc-title'>Set the value of the given option</span></p> </div> <a name='function.ldap-set-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_set_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$option</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$newval</tt></span> )</div> <p class='para rdfs-comment'> Sets the value of the specified option to be <i><tt class='parameter'>newval</tt></i> . </p> </div> <a name='function.ldap-set-option.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameter <i><tt class='parameter'>option</tt></i> can be one of: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Option</th> <th>Type</th> <th>Available since</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_DEREF</tt></b></td> <td align='left'>integer</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_SIZELIMIT</tt></b></td> <td align='left'>integer</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_TIMELIMIT</tt></b></td> <td align='left'>integer</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_NETWORK_TIMEOUT</tt></b></td> <td align='left'>integer</td> <td align='left'>PHP 5.3.0</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_PROTOCOL_VERSION</tt></b></td> <td align='left'>integer</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_ERROR_NUMBER</tt></b></td> <td align='left'>integer</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_REFERRALS</tt></b></td> <td align='left'>bool</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_RESTART</tt></b></td> <td align='left'>bool</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_HOST_NAME</tt></b></td> <td align='left'>string</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_ERROR_STRING</tt></b></td> <td align='left'>string</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_MATCHED_DN</tt></b></td> <td align='left'>string</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_SERVER_CONTROLS</tt></b></td> <td align='left'>array</td> <td class='empty'>&amp;nbsp;</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_CLIENT_CONTROLS</tt></b></td> <td align='left'>array</td> <td class='empty'>&amp;nbsp;</td> </tr> </tbody> </table> <p> </p> <p class='para'> <b><tt class='constant'>LDAP_OPT_SERVER_CONTROLS</tt></b> and <b><tt class='constant'>LDAP_OPT_CLIENT_CONTROLS</tt></b> require a list of controls, this means that the value must be an array of controls. A control consists of an <em class='emphasis'>oid</em> identifying the control, an optional <em class='emphasis'>value</em>, and an optional flag for <em class='emphasis'>criticality</em>. In PHP a control is given by an array containing an element with the key <em class='emphasis'>oid</em> and string value, and two optional elements. The optional elements are key <em class='emphasis'>value</em> with string value and key <em class='emphasis'>iscritical</em> with boolean value. <em class='emphasis'>iscritical</em> defaults to <em class='emphasis'><b><tt class='constant'>FALSE</tt></b></em> if not supplied. See <a href='http://www.openldap.org/devel/cvsweb.cgi/~checkout~/doc/drafts/draft-ietf-ldapext-ldap-c-api-xx.txt' class='link external'>&amp;raquo; draft-ietf-ldapext-ldap-c-api-xx.txt</a> for details. See also the second example below. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>newval</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new value for the specified <i><tt class='parameter'>option</tt></i> . </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-set-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-set-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Set protocol version</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ldap_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>LDAP_OPT_PROTOCOL_VERSION</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Using&amp;nbsp;LDAPv3'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Failed&amp;nbsp;to&amp;nbsp;set&amp;nbsp;protocol&amp;nbsp;version&amp;nbsp;to&amp;nbsp;3'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Set server controls</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br />//&amp;nbsp;control&amp;nbsp;with&amp;nbsp;no&amp;nbsp;value<br /></span><span style='color: #0000BB'>$ctrl1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'oid'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'1.2.752.58.10.1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'iscritical'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;iscritical&amp;nbsp;defaults&amp;nbsp;to&amp;nbsp;FALSE<br /></span><span style='color: #0000BB'>$ctrl2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'oid'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'1.2.752.58.1.10'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'value'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'magic'</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;try&amp;nbsp;to&amp;nbsp;set&amp;nbsp;both&amp;nbsp;controls<br /></span><span style='color: #007700'>if&amp;nbsp;(!</span><span style='color: #0000BB'>ldap_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>LDAP_OPT_SERVER_CONTROLS</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>$ctrl1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ctrl2</span><span style='color: #007700'>)))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Failed&amp;nbsp;to&amp;nbsp;set&amp;nbsp;server&amp;nbsp;controls'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-set-option.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x. <br /> </p></blockquote> </div> <a name='function.ldap-set-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-option.php' class='function' rel='rdfs-seeAlso'>ldap_get_option()</a> - Get the current value for given option</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_search" value="<div id='function.ldap-search' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-search.php'>ldap_search</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_search</span> &amp;mdash; <span class='dc-title'>Search LDAP tree</span></p> </div> <a name='function.ldap-search.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_search</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$base_dn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filter</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$attributes</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attrsonly</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sizelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$deref</tt></span> ]]]]] )</div> <p class='para rdfs-comment'> Performs the search for a specified filter on the directory with the scope of <b><tt class='constant'>LDAP_SCOPE_SUBTREE</tt></b>. This is equivalent to searching the entire directory. </p> <p class='para'> From 4.0.5 on it&amp;#039;s also possible to do parallel searches. To do this you use an array of link identifiers, rather than a single identifier, as the first argument. If you don&amp;#039;t want the same base DN and the same filter for all the searches, you can also use an array of base DNs and/or an array of filters. Those arrays must be of the same size as the link identifier array since the first entries of the arrays are used for one search, the second entries are used for another, and so on. When doing parallel searches an array of search result identifiers is returned, except in case of error, then the entry corresponding to the search will be <b><tt class='constant'>FALSE</tt></b>. This is very much like the value normally returned, except that a result identifier is always returned when a search was made. There are some rare cases where the normal search returns <b><tt class='constant'>FALSE</tt></b> while the parallel search returns an identifier. </p> </div> <a name='function.ldap-search.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base_dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base DN for the directory. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The search filter can be simple or advanced, using boolean operators in the format described in the LDAP documentation (see the <a href='http://www.mozilla.org/directory/csdk-docs/filter.htm' class='link external'>&amp;raquo; Netscape Directory SDK</a> for full information on filters). </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attributes</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of the required attributes, e.g. <i>array(&amp;quot;mail&amp;quot;, &amp;quot;sn&amp;quot;, &amp;quot;cn&amp;quot;)</i>. Note that the &amp;quot;dn&amp;quot; is always returned irrespective of which attributes types are requested. </p> <p class='para'> Using this parameter is much more efficient than the default action (which is to return all attributes and their associated values). The use of this parameter should therefore be considered good practice. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attrsonly</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should be set to 1 if only attribute types are wanted. If set to 0 both attributes types and attribute values are fetched which is the default behaviour. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sizelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Enables you to limit the count of entries fetched. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset sizelimit. You can set it lower though. <br /> Some directory server hosts will be configured to return no more than a preset number of entries. If this occurs, the server will indicate that it has only returned a partial results set. This also occurs if you use this parameter to limit the count of fetched entries. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset timelimit. You can set it lower though. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>deref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies how aliases should be handled during the search. It can be one of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_NEVER</tt></b> - (default) aliases are never dereferenced. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_SEARCHING</tt></b> - aliases should be dereferenced during the search but not when locating the base object of the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_FINDING</tt></b> - aliases should be dereferenced when locating the base object but not during the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_ALWAYS</tt></b> - aliases should be dereferenced always. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-search.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a search result identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-search.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.0.5</td> <td align='left'> Parallel searches support was added. </td> </tr> <tr valign='middle'> <td align='left'>4.0.2</td> <td align='left'> The <i><tt class='parameter'>attrsonly</tt></i> , <i><tt class='parameter'>sizelimit</tt></i> , <i><tt class='parameter'>timelimit</tt></i> and <i><tt class='parameter'>deref</tt></i> were added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ldap-search.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> The example below retrieves the organizational unit, surname, given name and email address for all people in &amp;quot;My Company&amp;quot; where the surname or given name contains the substring <var class='varname'>$person</var>. This example uses a boolean filter to tell the server to look for information in more than one attribute. </p><div class='example'> <p><b>Example #1 LDAP search</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br /><br />//&amp;nbsp;$person&amp;nbsp;is&amp;nbsp;all&amp;nbsp;or&amp;nbsp;part&amp;nbsp;of&amp;nbsp;a&amp;nbsp;person's&amp;nbsp;name,&amp;nbsp;eg&amp;nbsp;'Jo'<br /><br /></span><span style='color: #0000BB'>$dn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'o=My&amp;nbsp;Company,&amp;nbsp;c=US'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$filter</span><span style='color: #007700'>=</span><span style='color: #DD0000'>'(|(sn=</span><span style='color: #0000BB'>$person</span><span style='color: #DD0000'>*)(givenname=</span><span style='color: #0000BB'>$person</span><span style='color: #DD0000'>*))'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$justthese&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'ou'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'sn'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'givenname'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mail'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$sr</span><span style='color: #007700'>=</span><span style='color: #0000BB'>ldap_search</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$dn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$filter</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$justthese</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$info&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_get_entries</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sr</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;nbsp;entries&amp;nbsp;returned\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_rename" value="<div id='function.ldap-rename' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-rename.php'>ldap_rename</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_rename</span> &amp;mdash; <span class='dc-title'>Modify the name of an entry</span></p> </div> <a name='function.ldap-rename.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_rename</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$newrdn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$newparent</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$deleteoldrdn</tt></span> )</div> <p class='para rdfs-comment'> The entry specified by <i><tt class='parameter'>dn</tt></i> is renamed/moved. </p> </div> <a name='function.ldap-rename.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>newrdn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new RDN. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>newparent</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The new parent/superior entry. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>deleteoldrdn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If <b><tt class='constant'>TRUE</tt></b> the old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-rename.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-rename.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function currently only works with LDAPv3. You may have to use <a href='http://www.php.net/manual/en/function.ldap-set-option.php' class='function'>ldap_set_option()</a> prior to binding to use LDAPv3. This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x. <br /> </p></blockquote> </div> <a name='function.ldap-rename.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-modify.php' class='function' rel='rdfs-seeAlso'>ldap_modify()</a> - Modify an LDAP entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_read" value="<div id='function.ldap-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-read.php'>ldap_read</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_read</span> &amp;mdash; <span class='dc-title'>Read an entry</span></p> </div> <a name='function.ldap-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_read</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$base_dn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filter</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$attributes</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attrsonly</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sizelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$deref</tt></span> ]]]]] )</div> <p class='para rdfs-comment'> Performs the search for a specified <i><tt class='parameter'>filter</tt></i> on the directory with the scope <b><tt class='constant'>LDAP_SCOPE_BASE</tt></b>. So it is equivalent to reading an entry from the directory. </p> </div> <a name='function.ldap-read.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base_dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base DN for the directory. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An empty filter is not allowed. If you want to retrieve absolutely all information for this entry, use a filter of <i>objectClass=*</i>. If you know which entry types are used on the directory server, you might use an appropriate filter such as <i>objectClass=inetOrgPerson</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attributes</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of the required attributes, e.g. array(&amp;quot;mail&amp;quot;, &amp;quot;sn&amp;quot;, &amp;quot;cn&amp;quot;). Note that the &amp;quot;dn&amp;quot; is always returned irrespective of which attributes types are requested. </p> <p class='para'> Using this parameter is much more efficient than the default action (which is to return all attributes and their associated values). The use of this parameter should therefore be considered good practice. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attrsonly</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should be set to 1 if only attribute types are wanted. If set to 0 both attributes types and attribute values are fetched which is the default behaviour. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sizelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Enables you to limit the count of entries fetched. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset sizelimit. You can set it lower though. <br /> Some directory server hosts will be configured to return no more than a preset number of entries. If this occurs, the server will indicate that it has only returned a partial results set. This also occurs if you use this parameter to limit the count of fetched entries. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset timelimit. You can set it lower though. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>deref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies how aliases should be handled during the search. It can be one of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_NEVER</tt></b> - (default) aliases are never dereferenced. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_SEARCHING</tt></b> - aliases should be dereferenced during the search but not when locating the base object of the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_FINDING</tt></b> - aliases should be dereferenced when locating the base object but not during the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_ALWAYS</tt></b> - aliases should be dereferenced always. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a search result identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-read.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.0.5</td> <td align='left'> Parallel searches support was added. See <a href='http://www.php.net/manual/en/function.ldap-search.php' class='function'>ldap_search()</a> for details. </td> </tr> <tr valign='middle'> <td align='left'>4.0.2</td> <td align='left'> The <i><tt class='parameter'>attrsonly</tt></i> , <i><tt class='parameter'>sizelimit</tt></i> , <i><tt class='parameter'>timelimit</tt></i> and <i><tt class='parameter'>deref</tt></i> were added. </td> </tr> </tbody> </table> <p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_parse_result" value="<div id='function.ldap-parse-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-parse-result.php'>ldap_parse_result</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_parse_result</span> &amp;mdash; <span class='dc-title'>Extract information from result</span></p> </div> <a name='function.ldap-parse-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_parse_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></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 reference'>&amp;amp;$errcode</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$matcheddn</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter reference'>&amp;amp;$errmsg</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$referrals</tt></span> ]]] )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_parse_reference" value="<div id='function.ldap-parse-reference' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-parse-reference.php'>ldap_parse_reference</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_parse_reference</span> &amp;mdash; <span class='dc-title'>Extract information from reference entry</span></p> </div> <a name='function.ldap-parse-reference.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_parse_reference</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$entry</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter reference'>&amp;amp;$referrals</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_next_reference" value="<div id='function.ldap-next-reference' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-next-reference.php'>ldap_next_reference</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_next_reference</span> &amp;mdash; <span class='dc-title'>Get next reference</span></p> </div> <a name='function.ldap-next-reference.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_next_reference</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$entry</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_next_entry" value="<div id='function.ldap-next-entry' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-next-entry.php'>ldap_next_entry</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_next_entry</span> &amp;mdash; <span class='dc-title'>Get next result entry</span></p> </div> <a name='function.ldap-next-entry.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_next_entry</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> )</div> <p class='para rdfs-comment'> Retrieve the entries stored in the result. Successive calls to the <b>ldap_next_entry()</b> return entries one by one till there are no more entries. The first call to <b>ldap_next_entry()</b> is made after the call to <a href='http://www.php.net/manual/en/function.ldap-first-entry.php' class='function'>ldap_first_entry()</a> with the <i><tt class='parameter'>result_entry_identifier</tt></i> as returned from the <a href='http://www.php.net/manual/en/function.ldap-first-entry.php' class='function'>ldap_first_entry()</a>. </p> </div> <a name='function.ldap-next-entry.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-next-entry.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns entry identifier for the next entry in the result whose entries are being read starting with <a href='http://www.php.net/manual/en/function.ldap-first-entry.php' class='function'>ldap_first_entry()</a>. If there are no more entries in the result then it returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.ldap-next-entry.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-entries.php' class='function' rel='rdfs-seeAlso'>ldap_get_entries()</a> - Get all result entries</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_next_attribute" value="<div id='function.ldap-next-attribute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-next-attribute.php'>ldap_next_attribute</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_next_attribute</span> &amp;mdash; <span class='dc-title'>Get the next attribute in result</span></p> </div> <a name='function.ldap-next-attribute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_next_attribute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> )</div> <p class='para rdfs-comment'> Retrieves the attributes in an entry. The first call to <b>ldap_next_attribute()</b> is made with the <i><tt class='parameter'>result_entry_identifier</tt></i> returned from <a href='http://www.php.net/manual/en/function.ldap-first-attribute.php' class='function'>ldap_first_attribute()</a>. </p> </div> <a name='function.ldap-next-attribute.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ber_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The internal state of the pointer is maintained by this parameter. </p> <blockquote><p><b class='note'>Note</b>: This parameter is no longer used as this is now handled automatically by PHP. For backwards compatibility PHP will not throw an error if this parameter is passed. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.ldap-next-attribute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the next attribute in an entry on success and <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-next-attribute.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.4</td> <td align='left'> The <i><tt class='parameter'>ber_identifier</tt></i> was removed. This is now handled automatically by PHP. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ldap-next-attribute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-attributes.php' class='function' rel='rdfs-seeAlso'>ldap_get_attributes()</a> - Get attributes from a search result entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_modify" value="<div id='function.ldap-modify' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-modify.php'>ldap_modify</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_modify</span> &amp;mdash; <span class='dc-title'>Modify an LDAP entry</span></p> </div> <a name='function.ldap-modify.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_modify</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$entry</tt></span> )</div> <p class='para rdfs-comment'> Modify the existing entries in the LDAP directory. The structure of the entry is same as in <a href='http://www.php.net/manual/en/function.ldap-add.php' class='function'>ldap_add()</a>. </p> </div> <a name='function.ldap-modify.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>entry</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-modify.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-modify.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is binary-safe.</span></p></blockquote> </div> <a name='function.ldap-modify.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-rename.php' class='function' rel='rdfs-seeAlso'>ldap_rename()</a> - Modify the name of an entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_mod_replace" value="<div id='function.ldap-mod-replace' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-mod-replace.php'>ldap_mod_replace</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_mod_replace</span> &amp;mdash; <span class='dc-title'>Replace attribute values with new ones</span></p> </div> <a name='function.ldap-mod-replace.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_mod_replace</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$entry</tt></span> )</div> <p class='para rdfs-comment'> Replaces one or more attributes from the specified <i><tt class='parameter'>dn</tt></i> . It performs the modification at the attribute level as opposed to the object level. Object-level modifications are done by the <a href='http://www.php.net/manual/en/function.ldap-modify.php' class='function'>ldap_modify()</a> function. </p> </div> <a name='function.ldap-mod-replace.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>entry</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-mod-replace.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-mod-replace.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is binary-safe.</span></p></blockquote> </div> <a name='function.ldap-mod-replace.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-del.php' class='function' rel='rdfs-seeAlso'>ldap_mod_del()</a> - Delete attribute values from current attributes</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-add.php' class='function' rel='rdfs-seeAlso'>ldap_mod_add()</a> - Add attribute values to current attributes</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_mod_del" value="<div id='function.ldap-mod-del' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-mod-del.php'>ldap_mod_del</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_mod_del</span> &amp;mdash; <span class='dc-title'>Delete attribute values from current attributes</span></p> </div> <a name='function.ldap-mod-del.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_mod_del</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$entry</tt></span> )</div> <p class='para rdfs-comment'> Removes one or more attributes from the specified <i><tt class='parameter'>dn</tt></i> . It performs the modification at the attribute level as opposed to the object level. Object-level deletions are done by the <a href='http://www.php.net/manual/en/function.ldap-delete.php' class='function'>ldap_delete()</a> function. </p> </div> <a name='function.ldap-mod-del.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>entry</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-mod-del.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-mod-del.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-add.php' class='function' rel='rdfs-seeAlso'>ldap_mod_add()</a> - Add attribute values to current attributes</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-replace.php' class='function' rel='rdfs-seeAlso'>ldap_mod_replace()</a> - Replace attribute values with new ones</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_mod_add" value="<div id='function.ldap-mod-add' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-mod-add.php'>ldap_mod_add</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_mod_add</span> &amp;mdash; <span class='dc-title'>Add attribute values to current attributes</span></p> </div> <a name='function.ldap-mod-add.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_mod_add</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$entry</tt></span> )</div> <p class='para rdfs-comment'> Adds one or more attributes to the specified <i><tt class='parameter'>dn</tt></i> . It performs the modification at the attribute level as opposed to the object level. Object-level additions are done by the <a href='http://www.php.net/manual/en/function.ldap-add.php' class='function'>ldap_add()</a> function. </p> </div> <a name='function.ldap-mod-add.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>entry</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-mod-add.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-mod-add.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is binary-safe.</span></p></blockquote> </div> <a name='function.ldap-mod-add.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-del.php' class='function' rel='rdfs-seeAlso'>ldap_mod_del()</a> - Delete attribute values from current attributes</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-mod-replace.php' class='function' rel='rdfs-seeAlso'>ldap_mod_replace()</a> - Replace attribute values with new ones</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_list" value="<div id='function.ldap-list' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-list.php'>ldap_list</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_list</span> &amp;mdash; <span class='dc-title'>Single-level search</span></p> </div> <a name='function.ldap-list.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_list</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$base_dn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$filter</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$attributes</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$attrsonly</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$sizelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$timelimit</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$deref</tt></span> ]]]]] )</div> <p class='para rdfs-comment'> Performs the search for a specified <i><tt class='parameter'>filter</tt></i> on the directory with the scope <b><tt class='constant'>LDAP_SCOPE_ONELEVEL</tt></b>. </p> <p class='para'> <b><tt class='constant'>LDAP_SCOPE_ONELEVEL</tt></b> means that the search should only return information that is at the level immediately below the <i><tt class='parameter'>base_dn</tt></i> given in the call. (Equivalent to typing &amp;quot;<strong class='command'>ls</strong>&amp;quot; and getting a list of files and folders in the current working directory.) </p> </div> <a name='function.ldap-list.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>base_dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The base DN for the directory. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>filter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attributes</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of the required attributes, e.g. array(&amp;quot;mail&amp;quot;, &amp;quot;sn&amp;quot;, &amp;quot;cn&amp;quot;). Note that the &amp;quot;dn&amp;quot; is always returned irrespective of which attributes types are requested. </p> <p class='para'> Using this parameter is much more efficient than the default action (which is to return all attributes and their associated values). The use of this parameter should therefore be considered good practice. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attrsonly</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Should be set to 1 if only attribute types are wanted. If set to 0 both attributes types and attribute values are fetched which is the default behaviour. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>sizelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Enables you to limit the count of entries fetched. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset sizelimit. You can set it lower though. <br /> Some directory server hosts will be configured to return no more than a preset number of entries. If this occurs, the server will indicate that it has only returned a partial results set. This also occurs if you use this parameter to limit the count of fetched entries. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>timelimit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Sets the number of seconds how long is spend on the search. Setting this to 0 means no limit. </p> <blockquote><p><b class='note'>Note</b>: This parameter can NOT override server-side preset timelimit. You can set it lower though. <br /> </p></blockquote> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>deref</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies how aliases should be handled during the search. It can be one of the following: </p><ul class='itemizedlist'> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_NEVER</tt></b> - (default) aliases are never dereferenced. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_SEARCHING</tt></b> - aliases should be dereferenced during the search but not when locating the base object of the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_FINDING</tt></b> - aliases should be dereferenced when locating the base object but not during the search. </span> </li> <li class='listitem'> <span class='simpara'> <b><tt class='constant'>LDAP_DEREF_ALWAYS</tt></b> - aliases should be dereferenced always. </span> </li> </ul><p> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-list.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a search result identifier or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-list.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.0.5</td> <td align='left'> Parallel searches support was added. See <a href='http://www.php.net/manual/en/function.ldap-search.php' class='function'>ldap_search()</a> for details. </td> </tr> <tr valign='middle'> <td align='left'>4.0.2</td> <td align='left'> The <i><tt class='parameter'>attrsonly</tt></i> , <i><tt class='parameter'>sizelimit</tt></i> , <i><tt class='parameter'>timelimit</tt></i> and <i><tt class='parameter'>deref</tt></i> were added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ldap-list.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Produce a list of all organizational units of an organization</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> //&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br /><br />$basedn&amp;nbsp;=&amp;nbsp;'o=My&amp;nbsp;Company,&amp;nbsp;c=US';<br />$justthese&amp;nbsp;=&amp;nbsp;array('ou');<br /><br />$sr=ldap_list($ds,&amp;nbsp;$basedn,&amp;nbsp;'ou=*',&amp;nbsp;$justthese);<br /><br />$info&amp;nbsp;=&amp;nbsp;ldap_get_entries($ds,&amp;nbsp;$sr);<br /><br />for&amp;nbsp;($i=0;&amp;nbsp;$i&amp;lt;$info['count'];&amp;nbsp;$i++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;$info[$i]['ou'][0]&amp;nbsp;;<br />}</span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-list.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-search.php' class='function' rel='rdfs-seeAlso'>ldap_search()</a> - Search LDAP tree</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_values_len" value="<div id='function.ldap-get-values-len' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-values-len.php'>ldap_get_values_len</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_values_len</span> &amp;mdash; <span class='dc-title'>Get all binary values from a result entry</span></p> </div> <a name='function.ldap-get-values-len.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ldap_get_values_len</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$attribute</tt></span> )</div> <p class='para rdfs-comment'> Reads all the values of the attribute in the entry in the result. </p> <p class='para'> This function is used exactly like <a href='http://www.php.net/manual/en/function.ldap-get-values.php' class='function'>ldap_get_values()</a> except that it handles binary data and not string data. </p> </div> <a name='function.ldap-get-values-len.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attribute</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-values-len.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of values for the attribute on success and <b><tt class='constant'>FALSE</tt></b> on error. Individual values are accessed by integer index in the array. The first index is 0. The number of values can be found by indexing &amp;quot;count&amp;quot; in the resultant array. </p> </div> <a name='function.ldap-get-values-len.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-values.php' class='function' rel='rdfs-seeAlso'>ldap_get_values()</a> - Get all values from a result entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_values" value="<div id='function.ldap-get-values' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-values.php'>ldap_get_values</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_values</span> &amp;mdash; <span class='dc-title'>Get all values from a result entry</span></p> </div> <a name='function.ldap-get-values.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ldap_get_values</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$attribute</tt></span> )</div> <p class='para rdfs-comment'> Reads all the values of the attribute in the entry in the result. </p> <p class='para'> This call needs a <i><tt class='parameter'>result_entry_identifier</tt></i> , so needs to be preceded by one of the ldap search calls and one of the calls to get an individual entry. </p> <p class='para'> You application will either be hard coded to look for certain attributes (such as &amp;quot;surname&amp;quot; or &amp;quot;mail&amp;quot;) or you will have to use the <a href='http://www.php.net/manual/en/function.ldap-get-attributes.php' class='function'>ldap_get_attributes()</a> call to work out what attributes exist for a given entry. </p> </div> <a name='function.ldap-get-values.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attribute</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-values.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of values for the attribute on success and <b><tt class='constant'>FALSE</tt></b> on error. The number of values can be found by indexing &amp;quot;count&amp;quot; in the resultant array. Individual values are accessed by integer index in the array. The first index is 0. </p> <p class='para'> LDAP allows more than one entry for an attribute, so it can, for example, store a number of email addresses for one person&amp;#039;s directory entry all labeled with the attribute &amp;quot;mail&amp;quot; </p><div class='informalexample'> <pre class='literallayout'> return_value[&amp;quot;count&amp;quot;] = number of values for attribute return_value[0] = first value of attribute return_value[i] = ith value of attribute </pre> </div><p> </p> </div> <a name='function.ldap-get-values.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 List all values of the &amp;quot;mail&amp;quot; attribute for a directory entry </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br /><br />//&amp;nbsp;$sr&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;search&amp;nbsp;result&amp;nbsp;from&amp;nbsp;a&amp;nbsp;prior&amp;nbsp;call&amp;nbsp;to<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;one&amp;nbsp;of&amp;nbsp;the&amp;nbsp;ldap&amp;nbsp;directory&amp;nbsp;search&amp;nbsp;calls<br /><br />//&amp;nbsp;$entry&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;entry&amp;nbsp;identifier&amp;nbsp;from&amp;nbsp;a&amp;nbsp;prior&amp;nbsp;call&amp;nbsp;to<br />//&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;one&amp;nbsp;of&amp;nbsp;the&amp;nbsp;calls&amp;nbsp;that&amp;nbsp;returns&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;entry<br /><br /></span><span style='color: #0000BB'>$values&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_get_values</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$entry</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'mail'</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;email&amp;nbsp;addresses&amp;nbsp;for&amp;nbsp;this&amp;nbsp;entry.&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$values</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>];&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$values</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-get-values.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-values-len.php' class='function' rel='rdfs-seeAlso'>ldap_get_values_len()</a> - Get all binary values from a result entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_option" value="<div id='function.ldap-get-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-option.php'>ldap_get_option</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_option</span> &amp;mdash; <span class='dc-title'>Get the current value for given option</span></p> </div> <a name='function.ldap-get-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_get_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$option</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter reference'>&amp;amp;$retval</tt></span> )</div> <p class='para rdfs-comment'> Sets <i><tt class='parameter'>retval</tt></i> to the value of the specified option. </p> </div> <a name='function.ldap-get-option.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The parameter <i><tt class='parameter'>option</tt></i> can be one of: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Option</th> <th>Type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_DEREF</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_SIZELIMIT</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_TIMELIMIT</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_NETWORK_TIMEOUT</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_PROTOCOL_VERSION</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_ERROR_NUMBER</tt></b></td> <td align='left'>integer</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_REFERRALS</tt></b></td> <td align='left'>bool</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_RESTART</tt></b></td> <td align='left'>bool</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_HOST_NAME</tt></b></td> <td align='left'>string</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_ERROR_STRING</tt></b></td> <td align='left'>string</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_MATCHED_DN</tt></b></td> <td align='left'>string</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_SERVER_CONTROLS</tt></b></td> <td align='left'>array</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>LDAP_OPT_CLIENT_CONTROLS</tt></b></td> <td align='left'>array</td> </tr> </tbody> </table> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>retval</tt></i> </span> </dt><dd class='listitem'> <p class='para'> This will be set to the option value. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-get-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Check protocol version</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;a&amp;nbsp;directory&amp;nbsp;server<br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ldap_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>LDAP_OPT_PROTOCOL_VERSION</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$version</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Using&amp;nbsp;protocol&amp;nbsp;version&amp;nbsp;</span><span style='color: #0000BB'>$version</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;determine&amp;nbsp;protocol&amp;nbsp;version\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-get-option.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x. <br /> </p></blockquote> </div> <a name='function.ldap-get-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-set-option.php' class='function' rel='rdfs-seeAlso'>ldap_set_option()</a> - Set the value of the given option</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_entries" value="<div id='function.ldap-get-entries' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-entries.php'>ldap_get_entries</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_entries</span> &amp;mdash; <span class='dc-title'>Get all result entries</span></p> </div> <a name='function.ldap-get-entries.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ldap_get_entries</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_identifier</tt></span> )</div> <p class='para rdfs-comment'> Reads multiple entries from the given result, and then reading the attributes and multiple values. </p> </div> <a name='function.ldap-get-entries.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-entries.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a complete result information in a multi-dimensional array on success and <b><tt class='constant'>FALSE</tt></b> on error. </p> <p class='para'> The structure of the array is as follows. The attribute index is converted to lowercase. (Attributes are case-insensitive for directory servers, but not when used as array indices.) </p><div class='informalexample'> <div class='example-contents programlisting'> <div class='cdata'><pre> return_value[&amp;quot;count&amp;quot;] = number of entries in the result return_value[0] : refers to the details of first entry return_value[i][&amp;quot;dn&amp;quot;] = DN of the ith entry in the result return_value[i][&amp;quot;count&amp;quot;] = number of attributes in ith entry return_value[i][j] = jth attribute in the ith entry in the result return_value[i][&amp;quot;attribute&amp;quot;][&amp;quot;count&amp;quot;] = number of values for attribute in ith entry return_value[i][&amp;quot;attribute&amp;quot;][j] = jth value of attribute in ith entry </pre></div> </div> </div><p> </p> </div> <a name='function.ldap-get-entries.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-first-entry.php' class='function' rel='rdfs-seeAlso'>ldap_first_entry()</a> - Return first result id</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-next-entry.php' class='function' rel='rdfs-seeAlso'>ldap_next_entry()</a> - Get next result entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_dn" value="<div id='function.ldap-get-dn' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-dn.php'>ldap_get_dn</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_dn</span> &amp;mdash; <span class='dc-title'>Get the DN of a result entry</span></p> </div> <a name='function.ldap-get-dn.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_get_dn</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> )</div> <p class='para rdfs-comment'> Finds out the DN of an entry in the result. </p> </div> <a name='function.ldap-get-dn.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-dn.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the DN of the result entry and <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_get_attributes" value="<div id='function.ldap-get-attributes' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-get-attributes.php'>ldap_get_attributes</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_get_attributes</span> &amp;mdash; <span class='dc-title'>Get attributes from a search result entry</span></p> </div> <a name='function.ldap-get-attributes.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ldap_get_attributes</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> )</div> <p class='para rdfs-comment'> Reads attributes and values from an entry in the search result. </p> <p class='para'> Having located a specific entry in the directory, you can find out what information is held for that entry by using this call. You would use this call for an application which &amp;quot;browses&amp;quot; directory entries and/or where you do not know the structure of the directory entries. In many applications you will be searching for a specific attribute such as an email address or a surname, and won&amp;#039;t care what other data is held. </p><div class='informalexample'> <div class='example-contents programlisting'> <div class='cdata'><pre> return_value[&amp;quot;count&amp;quot;] = number of attributes in the entry return_value[0] = first attribute return_value[n] = nth attribute return_value[&amp;quot;attribute&amp;quot;][&amp;quot;count&amp;quot;] = number of values for attribute return_value[&amp;quot;attribute&amp;quot;][0] = first value of the attribute return_value[&amp;quot;attribute&amp;quot;][i] = (i+1)th value of the attribute </pre></div> </div> </div><p> </p> </div> <a name='function.ldap-get-attributes.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-get-attributes.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a complete entry information in a multi-dimensional array on success and <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-get-attributes.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Show the list of attributes held for a particular directory entry </b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;$ds&amp;nbsp;is&amp;nbsp;the&amp;nbsp;link&amp;nbsp;identifier&amp;nbsp;for&amp;nbsp;the&amp;nbsp;directory<br /><br />//&amp;nbsp;$sr&amp;nbsp;is&amp;nbsp;a&amp;nbsp;valid&amp;nbsp;search&amp;nbsp;result&amp;nbsp;from&amp;nbsp;a&amp;nbsp;prior&amp;nbsp;call&amp;nbsp;to<br />//&amp;nbsp;one&amp;nbsp;of&amp;nbsp;the&amp;nbsp;ldap&amp;nbsp;directory&amp;nbsp;search&amp;nbsp;calls<br /><br /></span><span style='color: #0000BB'>$entry&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_first_entry</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sr</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$attrs&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_get_attributes</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$entry</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #0000BB'>$attrs</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;attributes&amp;nbsp;held&amp;nbsp;for&amp;nbsp;this&amp;nbsp;entry:&amp;lt;p&amp;gt;'</span><span style='color: #007700'>;<br /><br />for&amp;nbsp;(</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>&amp;lt;&amp;nbsp;</span><span style='color: #0000BB'>$attrs</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>];&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$attrs</span><span style='color: #007700'>[</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-get-attributes.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-first-attribute.php' class='function' rel='rdfs-seeAlso'>ldap_first_attribute()</a> - Return first attribute</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-next-attribute.php' class='function' rel='rdfs-seeAlso'>ldap_next_attribute()</a> - Get the next attribute in result</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_free_result" value="<div id='function.ldap-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-free-result.php'>ldap_free_result</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_free_result</span> &amp;mdash; <span class='dc-title'>Free result memory</span></p> </div> <a name='function.ldap-free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_identifier</tt></span> )</div> <p class='para rdfs-comment'> Frees up the memory allocated internally to store the result. All result memory will be automatically freed when the script terminates. </p> <p class='para'> Typically all the memory allocated for the LDAP result gets freed at the end of the script. In case the script is making successive searches which return large result sets, <b>ldap_free_result()</b> could be called to keep the runtime memory usage by the script low. </p> </div> <a name='function.ldap-free-result.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_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_first_reference" value="<div id='function.ldap-first-reference' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-first-reference.php'>ldap_first_reference</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.5, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_first_reference</span> &amp;mdash; <span class='dc-title'>Return first reference</span></p> </div> <a name='function.ldap-first-reference.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_first_reference</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result</tt></span> )</div> <div class='warning'><b class='warning'>Warning</b><p class='simpara'>This function is currently not documented; only its argument list is available. </p></div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_first_entry" value="<div id='function.ldap-first-entry' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-first-entry.php'>ldap_first_entry</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_first_entry</span> &amp;mdash; <span class='dc-title'>Return first result id</span></p> </div> <a name='function.ldap-first-entry.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_first_entry</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_identifier</tt></span> )</div> <p class='para rdfs-comment'> Returns the entry identifier for first entry in the result. This entry identifier is then supplied to <a href='http://www.php.net/manual/en/function.ldap-next-entry.php' class='function'>ldap_next_entry()</a> routine to get successive entries from the result. </p> <p class='para'> Entries in the LDAP result are read sequentially using the <b>ldap_first_entry()</b> and <a href='http://www.php.net/manual/en/function.ldap-next-entry.php' class='function'>ldap_next_entry()</a> functions. </p> </div> <a name='function.ldap-first-entry.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-first-entry.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the result entry identifier for the first entry on success and <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-first-entry.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-entries.php' class='function' rel='rdfs-seeAlso'>ldap_get_entries()</a> - Get all result entries</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_first_attribute" value="<div id='function.ldap-first-attribute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-first-attribute.php'>ldap_first_attribute</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_first_attribute</span> &amp;mdash; <span class='dc-title'>Return first attribute</span></p> </div> <a name='function.ldap-first-attribute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_first_attribute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_entry_identifier</tt></span> )</div> <p class='para rdfs-comment'> Gets the first attribute in the given entry. Remaining attributes are retrieved by calling <a href='http://www.php.net/manual/en/function.ldap-next-attribute.php' class='function'>ldap_next_attribute()</a> successively. </p> <p class='para'> Similar to reading entries, attributes are also read one by one from a particular entry. </p> </div> <a name='function.ldap-first-attribute.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_entry_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>ber_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i><tt class='parameter'>ber_identifier</tt></i> is the identifier to internal memory location pointer. It is passed by reference. The same <i><tt class='parameter'>ber_identifier</tt></i> is passed to <a href='http://www.php.net/manual/en/function.ldap-next-attribute.php' class='function'>ldap_next_attribute()</a> , which modifies that pointer. </p> <blockquote><p><b class='note'>Note</b>: This parameter is no longer used as this is now handled automatically by PHP. For backwards compatibility PHP will not throw an error if this parameter is passed. <br /> </p></blockquote> </dd> </dl> <p> </p> </div> <a name='function.ldap-first-attribute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the first attribute in the entry on success and <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> <a name='function.ldap-first-attribute.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>5.2.4</td> <td align='left'> The <i><tt class='parameter'>ber_identifier</tt></i> was removed. This is now handled automatically by PHP. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ldap-first-attribute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-next-attribute.php' class='function' rel='rdfs-seeAlso'>ldap_next_attribute()</a> - Get the next attribute in result</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-get-attributes.php' class='function' rel='rdfs-seeAlso'>ldap_get_attributes()</a> - Get attributes from a search result entry</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_explode_dn" value="<div id='function.ldap-explode-dn' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-explode-dn.php'>ldap_explode_dn</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_explode_dn</span> &amp;mdash; <span class='dc-title'>Splits DN into its component parts</span></p> </div> <a name='function.ldap-explode-dn.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>ldap_explode_dn</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$with_attrib</tt></span> )</div> <p class='para rdfs-comment'> Splits the DN returned by <a href='http://www.php.net/manual/en/function.ldap-get-dn.php' class='function'>ldap_get_dn()</a> and breaks it up into its component parts. Each part is known as Relative Distinguished Name, or RDN. </p> </div> <a name='function.ldap-explode-dn.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'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>with_attrib</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Used to request if the RDNs are returned with only values or their attributes as well. To get RDNs with the attributes (i.e. in attribute=value format) set <i><tt class='parameter'>with_attrib</tt></i> to 0 and to get only values set it to 1. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-explode-dn.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an array of all DN components. The first element in this array has <i>count</i> key and represents the number of returned values, next elements are numerically indexed DN components. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_error" value="<div id='function.ldap-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-error.php'>ldap_error</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_error</span> &amp;mdash; <span class='dc-title'>Return the LDAP error message of the last LDAP command</span></p> </div> <a name='function.ldap-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_error</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> )</div> <p class='para rdfs-comment'> Returns the string error message explaining the error generated by the last LDAP command for the given <i><tt class='parameter'>link_identifier</tt></i> . While LDAP errno numbers are standardized, different libraries return different or even localized textual error messages. Never check for a specific error message text, but always use an error number to check. </p> <p class='para'> Unless you lower your warning level in your <var class='filename'>php.ini</var> sufficiently or prefix your LDAP commands with <i>@</i> (at) characters to suppress warning output, the errors generated will also show up in your HTML output. </p> </div> <a name='function.ldap-error.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns string error message. </p> </div> <a name='function.ldap-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-err2str.php' class='function' rel='rdfs-seeAlso'>ldap_err2str()</a> - Convert LDAP error number into string error message</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-errno.php' class='function' rel='rdfs-seeAlso'>ldap_errno()</a> - Return the LDAP error number of the last LDAP command</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_errno" value="<div id='function.ldap-errno' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-errno.php'>ldap_errno</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_errno</span> &amp;mdash; <span class='dc-title'>Return the LDAP error number of the last LDAP command</span></p> </div> <a name='function.ldap-errno.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>ldap_errno</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> )</div> <p class='para rdfs-comment'> Returns the standardized error number returned by the last LDAP command. This number can be converted into a textual error message using <a href='http://www.php.net/manual/en/function.ldap-err2str.php' class='function'>ldap_err2str()</a>. </p> </div> <a name='function.ldap-errno.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-errno.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Return the LDAP error number of the last LDAP command for this link. </p> </div> <a name='function.ldap-errno.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> Unless you lower your warning level in your <var class='filename'>php.ini</var> sufficiently or prefix your LDAP commands with @ (at) characters to suppress warning output, the errors generated will also show up in your HTML output. </p><div class='example'> <p><b>Example #1 Generating and catching an error</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>//&amp;nbsp;This&amp;nbsp;example&amp;nbsp;contains&amp;nbsp;an&amp;nbsp;error,&amp;nbsp;which&amp;nbsp;we&amp;nbsp;will&amp;nbsp;catch.<br /></span><span style='color: #0000BB'>$ld&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$bind&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ld</span><span style='color: #007700'>);<br /></span><span style='color: #FF8000'>//&amp;nbsp;syntax&amp;nbsp;error&amp;nbsp;in&amp;nbsp;filter&amp;nbsp;expression&amp;nbsp;(errno&amp;nbsp;87),<br />//&amp;nbsp;must&amp;nbsp;be&amp;nbsp;'objectclass=*'&amp;nbsp;to&amp;nbsp;work.<br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;nbsp;@</span><span style='color: #0000BB'>ldap_search</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ld</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'o=Myorg,&amp;nbsp;c=DE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'objectclass'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP-Errno:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ldap_errno</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ld</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP-Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ldap_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ld</span><span style='color: #007700'>)&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;die(</span><span style='color: #DD0000'>'Argh!&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>$info&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_get_entries</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ld</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'count'</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;matching&amp;nbsp;entries.&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-errno.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-err2str.php' class='function' rel='rdfs-seeAlso'>ldap_err2str()</a> - Convert LDAP error number into string error message</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-error.php' class='function' rel='rdfs-seeAlso'>ldap_error()</a> - Return the LDAP error message of the last LDAP command</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_err2str" value="<div id='function.ldap-err2str' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-err2str.php'>ldap_err2str</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_err2str</span> &amp;mdash; <span class='dc-title'>Convert LDAP error number into string error message</span></p> </div> <a name='function.ldap-err2str.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_err2str</b></span> ( <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$errno</tt></span> )</div> <p class='para rdfs-comment'> Returns the string error message explaining the error number <i><tt class='parameter'>errno</tt></i> . While LDAP errno numbers are standardized, different libraries return different or even localized textual error messages. Never check for a specific error message text, but always use an error number to check. </p> </div> <a name='function.ldap-err2str.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'>errno</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The error number. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-err2str.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the error message, as a string. </p> </div> <a name='function.ldap-err2str.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Enumerating all LDAP error messages</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>for&amp;nbsp;(</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>&amp;lt;</span><span style='color: #0000BB'>100</span><span style='color: #007700'>;&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>++)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'Error&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #DD0000'>:&amp;nbsp;%s&amp;lt;br&amp;nbsp;/&amp;gt;\n'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>ldap_err2str</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-err2str.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-errno.php' class='function' rel='rdfs-seeAlso'>ldap_errno()</a> - Return the LDAP error number of the last LDAP command</li> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-error.php' class='function' rel='rdfs-seeAlso'>ldap_error()</a> - Return the LDAP error message of the last LDAP command</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_dn2ufn" value="<div id='function.ldap-dn2ufn' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-dn2ufn.php'>ldap_dn2ufn</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_dn2ufn</span> &amp;mdash; <span class='dc-title'>Convert DN to User Friendly Naming format</span></p> </div> <a name='function.ldap-dn2ufn.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>ldap_dn2ufn</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> )</div> <p class='para rdfs-comment'> Turns the specified <i><tt class='parameter'>dn</tt></i> , into a more user-friendly form, stripping off type names. </p> </div> <a name='function.ldap-dn2ufn.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'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-dn2ufn.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the user friendly name. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_delete" value="<div id='function.ldap-delete' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-delete.php'>ldap_delete</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_delete</span> &amp;mdash; <span class='dc-title'>Delete an entry from a directory</span></p> </div> <a name='function.ldap-delete.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_delete</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> )</div> <p class='para rdfs-comment'> Deletes a particular entry in LDAP directory. </p> </div> <a name='function.ldap-delete.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-delete.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-delete.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-add.php' class='function' rel='rdfs-seeAlso'>ldap_add()</a> - Add entries to LDAP directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_count_entries" value="<div id='function.ldap-count-entries' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-count-entries.php'>ldap_count_entries</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_count_entries</span> &amp;mdash; <span class='dc-title'>Count the number of entries in a search</span></p> </div> <a name='function.ldap-count-entries.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>ldap_count_entries</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$result_identifier</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of entries stored in the result of previous search operations. </p> </div> <a name='function.ldap-count-entries.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>result_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The internal LDAP result. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-count-entries.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns number of entries in the result or <b><tt class='constant'>FALSE</tt></b> on error. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_connect" value="<div id='function.ldap-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-connect.php'>ldap_connect</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_connect</span> &amp;mdash; <span class='dc-title'>Connect to an LDAP server</span></p> </div> <a name='function.ldap-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>ldap_connect</b></span> ([ <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$hostname</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$port</tt><span class='initializer'> = 389</span></span> ]] )</div> <p class='para rdfs-comment'> Establishes a connection to a LDAP server on a specified <i><tt class='parameter'>hostname</tt></i> and <i><tt class='parameter'>port</tt></i> . </p> </div> <a name='function.ldap-connect.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'>hostname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> If you are using OpenLDAP 2.x.x you can specify a URL instead of the hostname. To use LDAP with SSL, compile OpenLDAP 2.x.x with SSL support, configure PHP with SSL, and set this parameter as <i>ldaps://hostname/</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The port to connect to. Not used when using URLs. Defaults to 389. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a positive LDAP link identifier on success, or <b><tt class='constant'>FALSE</tt></b> on error. When OpenLDAP 2.x.x is used, <b>ldap_connect()</b> will always return a <a href='http://www.php.net/manual/en/language.types.resource.php' class='type resource'>resource</a> as it does not actually connect but just initializes the connecting parameters. The actual connect happens with the next calls to ldap_* funcs, usually with <a href='http://www.php.net/manual/en/function.ldap-bind.php' class='function'>ldap_bind()</a>. </p> <p class='para'> If no arguments are specified then the link identifier of the already opened link will be returned. </p> </div> <a name='function.ldap-connect.changelog'></a><div class='refsect1 changelog'> <h3 class='title'>Changelog</h3> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Version</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>4.0.4</td> <td align='left'> URL and SSL support was added. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.ldap-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Example of connecting to LDAP server.</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;LDAP&amp;nbsp;variables<br /></span><span style='color: #0000BB'>$ldaphost&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ldap.example.com'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;your&amp;nbsp;ldap&amp;nbsp;servers<br /></span><span style='color: #0000BB'>$ldapport&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>389</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;your&amp;nbsp;ldap&amp;nbsp;server's&amp;nbsp;port&amp;nbsp;number<br /><br />//&amp;nbsp;Connecting&amp;nbsp;to&amp;nbsp;LDAP<br /></span><span style='color: #0000BB'>$ldapconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ldaphost</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ldapport</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;</span><span style='color: #0000BB'>$ldaphost</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Example of connecting securely to LDAP server.</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;make&amp;nbsp;sure&amp;nbsp;your&amp;nbsp;host&amp;nbsp;is&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;one<br />//&amp;nbsp;that&amp;nbsp;you&amp;nbsp;issued&amp;nbsp;your&amp;nbsp;secure&amp;nbsp;certificate&amp;nbsp;to<br /></span><span style='color: #0000BB'>$ldaphost&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ldaps://ldap.example.com/'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Connecting&amp;nbsp;to&amp;nbsp;LDAP<br /></span><span style='color: #0000BB'>$ldapconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ldaphost</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$ldaphost</span><span style='color: #007700'>}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-bind.php' class='function' rel='rdfs-seeAlso'>ldap_bind()</a> - Bind to LDAP directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_compare" value="<div id='function.ldap-compare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-compare.php'>ldap_compare</a></h1> <p class='verinfo'>(PHP 4 &amp;gt;= 4.0.2, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_compare</span> &amp;mdash; <span class='dc-title'>Compare value of attribute found in entry specified with DN</span></p> </div> <a name='function.ldap-compare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>ldap_compare</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$attribute</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$value</tt></span> )</div> <p class='para rdfs-comment'> Compare <i><tt class='parameter'>value</tt></i> of <i><tt class='parameter'>attribute</tt></i> with value of same attribute in an LDAP directory entry. </p> </div> <a name='function.ldap-compare.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>attribute</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The attribute name. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The compared value. </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-compare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if <i><tt class='parameter'>value</tt></i> matches otherwise returns <b><tt class='constant'>FALSE</tt></b>. Returns -1 on error. </p> </div> <a name='function.ldap-compare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> The following example demonstrates how to check whether or not given password matches the one defined in DN specified entry. </p> <p class='para'> </p><div class='example'> <p><b>Example #1 Complete example of password check</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$ds</span><span style='color: #007700'>=</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;assuming&amp;nbsp;the&amp;nbsp;LDAP&amp;nbsp;server&amp;nbsp;is&amp;nbsp;on&amp;nbsp;this&amp;nbsp;host<br /><br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;bind<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>ldap_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>))&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;prepare&amp;nbsp;data<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$dn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'cn=Matti&amp;nbsp;Meikku,&amp;nbsp;ou=My&amp;nbsp;Unit,&amp;nbsp;o=My&amp;nbsp;Company,&amp;nbsp;c=FI'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$value&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'secretpassword'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$attr&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;compare&amp;nbsp;value<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$r</span><span style='color: #007700'>=</span><span style='color: #0000BB'>ldap_compare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$dn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$attr</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$value</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;-</span><span style='color: #0000BB'>1</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Error:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>ldap_error</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;elseif&amp;nbsp;(</span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>true</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Password&amp;nbsp;correct.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;elseif&amp;nbsp;(</span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>===&amp;nbsp;</span><span style='color: #0000BB'>false</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Wrong&amp;nbsp;guess!&amp;nbsp;Password&amp;nbsp;incorrect.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;bind&amp;nbsp;to&amp;nbsp;LDAP&amp;nbsp;server.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>ldap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>);<br /><br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;LDAP&amp;nbsp;server.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-compare.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <div class='warning'><b class='warning'>Warning</b> <p class='para'> <b>ldap_compare()</b> can NOT be used to compare BINARY values! </p> </div> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_close" value="<div id='function.ldap-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-close.php'>ldap_close</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_close</span> &amp;mdash; <span class='dc-title'>Alias of <a href='http://www.php.net/manual/en/function.ldap-unbind.php' class='function'>ldap_unbind()</a></span></p> </div> <a name='function.ldap-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <p class='simpara'> This function is an alias of: <a href='http://www.php.net/manual/en/function.ldap-unbind.php' class='function'>ldap_unbind()</a>. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_bind" value="<div id='function.ldap-bind' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-bind.php'>ldap_bind</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_bind</span> &amp;mdash; <span class='dc-title'>Bind to LDAP directory</span></p> </div> <a name='function.ldap-bind.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_bind</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$bind_rdn</tt><span class='initializer'> = NULL</span></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$bind_password</tt><span class='initializer'> = NULL</span></span> ]] )</div> <p class='para rdfs-comment'> Binds to the LDAP directory with specified RDN and password. </p> </div> <a name='function.ldap-bind.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>bind_rdn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>bind_password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> </p> </dd> </dl> <p> </p> <p class='para'> If <i><tt class='parameter'>bind_rdn</tt></i> and <i><tt class='parameter'>bind_password</tt></i> are not specified, an anonymous bind is attempted. </p> </div> <a name='function.ldap-bind.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-bind.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Using LDAP Bind</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;using&amp;nbsp;ldap&amp;nbsp;bind<br /></span><span style='color: #0000BB'>$ldaprdn&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'uname'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;ldap&amp;nbsp;rdn&amp;nbsp;or&amp;nbsp;dn<br /></span><span style='color: #0000BB'>$ldappass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'password'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;associated&amp;nbsp;password<br /><br />//&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;ldap&amp;nbsp;server<br /></span><span style='color: #0000BB'>$ldapconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ldap.example.com'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;LDAP&amp;nbsp;server.'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ldapconn</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;binding&amp;nbsp;to&amp;nbsp;ldap&amp;nbsp;server<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ldapbind&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ldapconn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ldaprdn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$ldappass</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;verify&amp;nbsp;binding<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$ldapbind</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP&amp;nbsp;bind&amp;nbsp;successful...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP&amp;nbsp;bind&amp;nbsp;failed...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Using LDAP Bind Anonymously</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>//using&amp;nbsp;ldap&amp;nbsp;bind&amp;nbsp;anonymously<br /><br />//&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;ldap&amp;nbsp;server<br /></span><span style='color: #0000BB'>$ldapconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'ldap.example.com'</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;or&amp;nbsp;die(</span><span style='color: #DD0000'>'Could&amp;nbsp;not&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;LDAP&amp;nbsp;server.'</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ldapconn</span><span style='color: #007700'>)&amp;nbsp;{<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;binding&amp;nbsp;anonymously<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ldapbind&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ldapconn</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$ldapbind</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP&amp;nbsp;bind&amp;nbsp;anonymous&amp;nbsp;successful...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LDAP&amp;nbsp;bind&amp;nbsp;anonymous&amp;nbsp;failed...'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-bind.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-unbind.php' class='function' rel='rdfs-seeAlso'>ldap_unbind()</a> - Unbind from LDAP directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="ldap_add" value="<div id='function.ldap-add' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.ldap-add.php'>ldap_add</a></h1> <p class='verinfo'>(PHP 4, PHP 5)</p><p class='refpurpose'><span class='refname'>ldap_add</span> &amp;mdash; <span class='dc-title'>Add entries to LDAP directory</span></p> </div> <a name='function.ldap-add.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>ldap_add</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$link_identifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$dn</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$entry</tt></span> )</div> <p class='para rdfs-comment'> Add entries in the LDAP directory. </p> </div> <a name='function.ldap-add.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'>link_identifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An LDAP link identifier, returned by <a href='http://www.php.net/manual/en/function.ldap-connect.php' class='function'>ldap_connect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>dn</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The distinguished name of an LDAP entity. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>entry</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array that specifies the information about the entry. The values in the entries are indexed by individual attributes. In case of multiple values for an attribute, they are indexed using integers starting with 0. </p><div class='informalexample'> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$entree</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'attribut1'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'value'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$entree</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'attribut2'</span><span style='color: #007700'>][</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'value1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$entree</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'attribut2'</span><span style='color: #007700'>][</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'value2'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </dd> </dl> <p> </p> </div> <a name='function.ldap-add.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.ldap-add.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Complete example with authenticated bind</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$ds&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>);&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;assuming&amp;nbsp;the&amp;nbsp;LDAP&amp;nbsp;server&amp;nbsp;is&amp;nbsp;on&amp;nbsp;this&amp;nbsp;host<br /><br /></span><span style='color: #007700'>if&amp;nbsp;(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;bind&amp;nbsp;with&amp;nbsp;appropriate&amp;nbsp;dn&amp;nbsp;to&amp;nbsp;give&amp;nbsp;update&amp;nbsp;access<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_bind</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cn=root,&amp;nbsp;o=My&amp;nbsp;Company,&amp;nbsp;c=US'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'secret'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;prepare&amp;nbsp;data<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'cn'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'John&amp;nbsp;Jones'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'sn'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'Jones'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'mail'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'jonj@example.com'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'objectclass'</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'person'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;add&amp;nbsp;data&amp;nbsp;to&amp;nbsp;directory<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$r&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>ldap_add</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cn=John&amp;nbsp;Jones,&amp;nbsp;o=My&amp;nbsp;Company,&amp;nbsp;c=US'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$info</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>ldap_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$ds</span><span style='color: #007700'>);<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Unable&amp;nbsp;to&amp;nbsp;connect&amp;nbsp;to&amp;nbsp;LDAP&amp;nbsp;server'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.ldap-add.notes'></a><div class='refsect1 notes'> <h3 class='title'>Notes</h3> <blockquote><p><b class='note'>Note</b>: <span class='simpara'>This function is binary-safe.</span></p></blockquote> </div> <a name='function.ldap-add.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.ldap-delete.php' class='function' rel='rdfs-seeAlso'>ldap_delete()</a> - Delete an entry from a directory</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_tables" value="<div id='function.db2-tables' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-tables.php'>db2_tables</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_tables</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the tables and associated metadata in a database </span></p> </div> <a name='function.db2-tables.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_tables</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-type</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Returns a result set listing the tables and associated metadata in a database. </p> </div> <a name='function.db2-tables.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A list of comma-delimited table type identifiers. To match all table types, pass <b><tt class='constant'>NULL</tt></b> or an empty string. Valid table type identifiers include: ALIAS, HIERARCHY TABLE, INOPERATIVE VIEW, NICKNAME, MATERIALIZED QUERY TABLE, SYSTEM TABLE, TABLE, TYPED TABLE, TYPED VIEW, and VIEW. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-tables.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the tables that match the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'>The catalog that contains the table. The value is <b><tt class='constant'>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'>Name of the schema that contains the table.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_TYPE</td> <td align='left'>Table type identifier for the table.</td> </tr> <tr valign='middle'> <td align='left'>REMARKS</td> <td align='left'>Description of the table.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-tables.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_table_privileges" value="<div id='function.db2-table-privileges' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-table-privileges.php'>db2_table_privileges</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_table_privileges</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the tables and associated privileges in a database </span></p> </div> <a name='function.db2-table-privileges.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_table_privileges</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> ]]] )</div> <p class='para rdfs-comment'> Returns a result set listing the tables and associated privileges in a database. </p> </div> <a name='function.db2-table-privileges.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-table-privileges.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the privileges for the tables that match the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'>The catalog that contains the table. The value is <b><tt class='constant'>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'>Name of the schema that contains the table.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table.</td> </tr> <tr valign='middle'> <td align='left'>GRANTOR</td> <td align='left'>Authorization ID of the user who granted the privilege.</td> </tr> <tr valign='middle'> <td align='left'>GRANTEE</td> <td align='left'>Authorization ID of the user to whom the privilege was granted.</td> </tr> <tr valign='middle'> <td align='left'>PRIVILEGE</td> <td align='left'> The privilege that has been granted. This can be one of ALTER, CONTROL, DELETE, INDEX, INSERT, REFERENCES, SELECT, or UPDATE. </td> </tr> <tr valign='middle'> <td align='left'>IS_GRANTABLE</td> <td align='left'> A string value of &amp;quot;YES&amp;quot; or &amp;quot;NO&amp;quot; indicating whether the grantee can grant the privilege to other users. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-table-privileges.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_stmt_errormsg" value="<div id='function.db2-stmt-errormsg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php'>db2_stmt_errormsg</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_stmt_errormsg</span> &amp;mdash; <span class='dc-title'> Returns a string containing the last SQL statement error message </span></p> </div> <a name='function.db2-stmt-errormsg.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_stmt_errormsg</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> ] )</div> <p class='para rdfs-comment'> Returns a string containing the last SQL statement error message. </p> <p class='para'> If you do not pass a statement resource as an argument to <b>db2_stmt_errormsg()</b>, the driver returns the error message associated with the last attempt to return a statement resource, for example, from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> or <a href='http://www.php.net/manual/en/function.db2-exec.php' class='function'>db2_exec()</a>. </p> </div> <a name='function.db2-stmt-errormsg.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-stmt-errormsg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the error message and SQLCODE value for the last error that occurred issuing an SQL statement. </p> </div> <a name='function.db2-stmt-errormsg.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-error.php' class='function' rel='rdfs-seeAlso'>db2_conn_error()</a> - Returns a string containing the SQLSTATE returned by the last connection attempt</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_conn_errormsg()</a> - Returns the last connection error message and SQLCODE value</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-error.php' class='function' rel='rdfs-seeAlso'>db2_stmt_error()</a> - Returns a string containing the SQLSTATE returned by an SQL statement</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_stmt_error" value="<div id='function.db2-stmt-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-stmt-error.php'>db2_stmt_error</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_stmt_error</span> &amp;mdash; <span class='dc-title'> Returns a string containing the SQLSTATE returned by an SQL statement </span></p> </div> <a name='function.db2-stmt-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_stmt_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> ] )</div> <p class='para rdfs-comment'> Returns a string containing the SQLSTATE value returned by an SQL statement. </p> <p class='para'> If you do not pass a statement resource as an argument to <b>db2_stmt_error()</b>, the driver returns the SQLSTATE value associated with the last attempt to return a statement resource, for example, from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> or <a href='http://www.php.net/manual/en/function.db2-exec.php' class='function'>db2_exec()</a>. </p> <p class='para'> To learn what the SQLSTATE value means, you can issue the following command at a DB2 Command Line Processor prompt: <strong class='userinput'><code>db2 &amp;#039;? <i><tt class='parameter'>sqlstate-value</tt></i> &amp;#039;</code></strong> . You can also call <a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function'>db2_stmt_errormsg()</a> to retrieve an explicit error message and the associated SQLCODE value. </p> </div> <a name='function.db2-stmt-error.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-stmt-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing an SQLSTATE value. </p> </div> <a name='function.db2-stmt-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-error.php' class='function' rel='rdfs-seeAlso'>db2_conn_error()</a> - Returns a string containing the SQLSTATE returned by the last connection attempt</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_conn_errormsg()</a> - Returns the last connection error message and SQLCODE value</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_stmt_errormsg()</a> - Returns a string containing the last SQL statement error message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_statistics" value="<div id='function.db2-statistics' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-statistics.php'>db2_statistics</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_statistics</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the index and statistics for a table </span></p> </div> <a name='function.db2-statistics.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_statistics</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> , <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$unique</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the index and statistics for a table. </p> </div> <a name='function.db2-statistics.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema that contains the targeted table. If this parameter is <b><tt class='constant'>NULL</tt></b>, the statistics and indexes are returned for the schema of the current user. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>unique</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An integer value representing the type of index information to return. </p><dl> <dt class='varlistentry'> <br /><span class='term'><i><tt class='parameter'>0</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Return only the information for unique indexes on the table. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>1</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Return the information for all indexes on the table. </p> </dd> </dl> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.db2-statistics.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the statistics and indexes for the base tables matching the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'>The catalog that contains the table. The value is <b><tt class='constant'>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'>Name of the schema that contains the table.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table.</td> </tr> <tr valign='middle'> <td align='left'>NON_UNIQUE</td> <td align='left'> <p class='para'> An integer value representing whether the index prohibits unique values, or whether the row represents statistics on the table itself: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Return value</th> <th>Parameter type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0 (SQL_FALSE)</td> <td align='left'>The index allows duplicate values.</td> </tr> <tr valign='middle'> <td align='left'>1 (SQL_TRUE)</td> <td align='left'>The index values must be unique.</td> </tr> <tr valign='middle'> <td align='left'><b><tt class='constant'>NULL</tt></b></td> <td align='left'>This row is statistics information for the table itself.</td> </tr> </tbody> </table> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>INDEX_QUALIFIER</td> <td align='left'>A string value representing the qualifier that would have to be prepended to INDEX_NAME to fully qualify the index.</td> </tr> <tr valign='middle'> <td align='left'>INDEX_NAME</td> <td align='left'>A string representing the name of the index.</td> </tr> <tr valign='middle'> <td align='left'>TYPE</td> <td align='left'> <p class='para'> An integer value representing the type of information contained in this row of the result set: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Return value</th> <th>Parameter type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0 (SQL_TABLE_STAT)</td> <td align='left'>The row contains statistics about the table itself.</td> </tr> <tr valign='middle'> <td align='left'>1 (SQL_INDEX_CLUSTERED)</td> <td align='left'>The row contains information about a clustered index.</td> </tr> <tr valign='middle'> <td align='left'>2 (SQL_INDEX_HASH)</td> <td align='left'>The row contains information about a hashed index.</td> </tr> <tr valign='middle'> <td align='left'>3 (SQL_INDEX_OTHER)</td> <td align='left'>The row contains information about a type of index that is neither clustered nor hashed.</td> </tr> </tbody> </table> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>ORDINAL_POSITION</td> <td align='left'>The 1-indexed position of the column in the index. <b><tt class='constant'>NULL</tt></b> if the row contains statistics information about the table itself.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>The name of the column in the index. <b><tt class='constant'>NULL</tt></b> if the row contains statistics information about the table itself.</td> </tr> <tr valign='middle'> <td align='left'>ASC_OR_DESC</td> <td align='left'> <i>A</i> if the column is sorted in ascending order, <i>D</i> if the column is sorted in descending order, <b><tt class='constant'>NULL</tt></b> if the row contains statistics information about the table itself. </td> </tr> <tr valign='middle'> <td align='left'>CARDINALITY</td> <td align='left'> <p class='para'> If the row contains information about an index, this column contains an integer value representing the number of unique values in the index. </p> <p class='para'> If the row contains information about the table itself, this column contains an integer value representing the number of rows in the table. </p> </td> </tr> <tr valign='middle'> <td align='left'>PAGES</td> <td align='left'> <p class='para'> If the row contains information about an index, this column contains an integer value representing the number of pages used to store the index. </p> <p class='para'> If the row contains information about the table itself, this column contains an integer value representing the number of pages used to store the table. </p> </td> </tr> <tr valign='middle'> <td align='left'>FILTER_CONDITION</td> <td align='left'>Always returns <b><tt class='constant'>NULL</tt></b>.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-statistics.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_special_columns" value="<div id='function.db2-special-columns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-special-columns.php'>db2_special_columns</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_special_columns</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the unique row identifier columns for a table </span></p> </div> <a name='function.db2-special-columns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_special_columns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table_name</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scope</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the unique row identifier columns for a table. </p> </div> <a name='function.db2-special-columns.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table_name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>scope</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Integer value representing the minimum duration for which the unique row identifier is valid. This can be one of the following values: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Integer value</th> <th>SQL constant</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>SQL_SCOPE_CURROW</td> <td align='left'>Row identifier is valid only while the cursor is positioned on the row.</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>SQL_SCOPE_TRANSACTION</td> <td align='left'>Row identifier is valid for the duration of the transaction.</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>SQL_SCOPE_SESSION</td> <td align='left'>Row identifier is valid for the duration of the connection.</td> </tr> </tbody> </table> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.db2-special-columns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows with unique row identifier information for a table. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>SCOPE</td> <td align='left'> <p class='para'> </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Integer value</th> <th>SQL constant</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>0</td> <td align='left'>SQL_SCOPE_CURROW</td> <td align='left'>Row identifier is valid only while the cursor is positioned on the row.</td> </tr> <tr valign='middle'> <td align='left'>1</td> <td align='left'>SQL_SCOPE_TRANSACTION</td> <td align='left'>Row identifier is valid for the duration of the transaction.</td> </tr> <tr valign='middle'> <td align='left'>2</td> <td align='left'>SQL_SCOPE_SESSION</td> <td align='left'>Row identifier is valid for the duration of the connection.</td> </tr> </tbody> </table> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>Name of the unique column.</td> </tr> <tr valign='middle'> <td align='left'>DATA_TYPE</td> <td align='left'>SQL data type for the column.</td> </tr> <tr valign='middle'> <td align='left'>TYPE_NAME</td> <td align='left'>Character string representation of the SQL data type for the column.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_SIZE</td> <td align='left'>An integer value representing the size of the column.</td> </tr> <tr valign='middle'> <td align='left'>BUFFER_LENGTH</td> <td align='left'> Maximum number of bytes necessary to store data from this column. </td> </tr> <tr valign='middle'> <td align='left'>DECIMAL_DIGITS</td> <td align='left'> The scale of the column, or <b><tt class='constant'>NULL</tt></b> where scale is not applicable. </td> </tr> <tr valign='middle'> <td align='left'>NUM_PREC_RADIX</td> <td align='left'> An integer value of either <i>10</i> (representing an exact numeric data type), <i>2</i> (representing an approximate numeric data type), or <b><tt class='constant'>NULL</tt></b> (representing a data type for which radix is not applicable). </td> </tr> <tr valign='middle'> <td align='left'>PSEUDO_COLUMN</td> <td align='left'>Always returns 1.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-special-columns.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_set_option" value="<div id='function.db2-set-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-set-option.php'>db2_set_option</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_set_option</span> &amp;mdash; <span class='dc-title'>Set options for connection or statement resources</span></p> </div> <a name='function.db2-set-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_set_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$resource</tt></span> , <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$options</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$type</tt></span> )</div> <p class='para rdfs-comment'> Sets options for a statement resource or a connection resource. You cannot set options for result set resources. </p> </div> <a name='function.db2-set-option.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'>resource</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource as returned from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> or a valid connection resource as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array containing valid statement or connection options. This parameter can be used to change autocommit values, cursor types (scrollable or forward), and to specify the case of the column names (lower, upper, or natural) that will appear in a result set. </p><dl> <dt class='varlistentry'> <br /><span class='term'><i><tt class='parameter'>autocommit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing <i>DB2_AUTOCOMMIT_ON</i> turns autocommit on for the specified connection resource. </p> <p class='para'> Passing <i>DB2_AUTOCOMMIT_OFF</i> turns autocommit off for the specified connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>cursor</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing <i>DB2_FORWARD_ONLY</i> specifies a forward-only cursor for a statement resource. This is the default cursor type, and is supported by all database servers. </p> <p class='para'> Passing <i>DB2_SCROLLABLE</i> specifies a scrollable cursor for a statement resource. Scrollable cursors enable result set rows to be accessed in non-sequential order, but are only supported by IBM DB2 Universal Database databases. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>binmode</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing <i>DB2_BINARY</i> specifies that binary data will be returned as is. This is the default mode. This is the equivalent of setting <i>ibm_db2.binmode=1</i> in <var class='filename'>php.ini</var>. </p> <p class='para'> Passing <i>DB2_CONVERT</i> specifies that binary data will be converted to hexadecimal encoding, and will be returned as such. This is the equivalent of setting <i>ibm_db2.binmode=2</i> in <var class='filename'>php.ini</var>. </p> <p class='para'> Passing <i>DB2_PASSTHRU</i> specifies that binary data will be converted to <b><tt class='constant'>NULL</tt></b>. This is the equivalent of setting <i>ibm_db2.binmode=3</i> in <var class='filename'>php.ini</var>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>db2_attr_case</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing <i>DB2_CASE_LOWER</i> specifies that column names of the result set are returned in lower case. </p> <p class='para'> Passing <i>DB2_CASE_UPPER</i> specifies that column names of the result set are returned in upper case. </p> <p class='para'> Passing <i>DB2_CASE_NATURAL</i> specifies that column names of the result set are returned in natural case. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>deferred_prepare</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing <i>DB2_DEFERRED_PREPARE_ON</i> turns deferred prepare on for the specified statement resource. </p> <p class='para'> Passing <i>DB2_DEFERRED_PREPARE_OFF</i> turns deferred prepare off for the specified statement resource. </p> </dd> </dl> <p> </p> <p class='para'> The following new i5/OS options are available in ibm_db2 version 1.5.1 and later. These options apply only when running PHP and ibm_db2 natively on i5 systems. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_fetch_only</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_FETCH_ON</i> - Cursors are read-only and cannot be used for positioned updates or deletes. This is the default unless <i>SQL_ATTR_FOR_FETCH_ONLY</i> environment has been set to <i>SQL_FALSE</i>. </p> <p class='para'> <i>DB2_I5_FETCH_OFF</i> - Cursors can be used for positioned updates and deletes. </p> </dd> </dl> <p> </p> <p class='para'> The following new option is available in ibm_db2 version 1.8.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>rowcount</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_ROWCOUNT_PREFETCH_ON</i> - Client can request the full row count prior to fetching, which means that <a href='http://www.php.net/manual/en/function.db2-num-rows.php' class='function'>db2_num_rows()</a> returns the number of rows selected even when a <i>ROLLFORWARD_ONLY</i> cursor is used. </p> <p class='para'> <i>DB2_ROWCOUNT_PREFETCH_OFF</i> - Client cannot request the full row count prior to fetching. </p> </dd> </dl> <p> </p> <p class='para'> The following new options are available in ibm_db2 version 1.7.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>trusted_user</tt></i> </span> </dt><dd class='listitem'> <p class='para'> To switch the user to a trusted user, pass the User ID (String) of the trusted user as the value of this key. This option can be set on a connection resource only. To use this option, trusted context must be enabled on the connection resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>trusted_password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password (String) that corresponds to the user specified by the trusted_user key. </p> </dd> </dl> <p> </p> <p class='para'> The following new options are available in ibm_db2 version 1.6.0 and later. These options provide useful tracking information that can be accessed during execution with <a href='http://www.php.net/manual/en/function.db2-get-option.php' class='function'>db2_get_option()</a>. </p><blockquote><p><b class='note'>Note</b>: When the value in each option is being set, some servers might not handle the entire length provided and might truncate the value. <br /> To ensure that the data specified in each option is converted correctly when transmitted to a host system, use only the characters A through Z, 0 through 9, and the underscore (_) or period (.). <br /> </p></blockquote><p> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>userid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_USERID</i> - A pointer to a null-terminated character string used to identify the client user ID sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: DB2 for z/OS and OS/390 servers support up to a length of 16 characters. This user-id is not to be confused with the authentication user-id, it is for identification purposes only and is not used for any authorization. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>acctstr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_ACCTSTR</i> - A pointer to a null-terminated character string used to identify the client accounting string sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: DB2 for z/OS and OS/390 servers support up to a length of 200 characters. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>applname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_APPLNAME</i> - A pointer to a null-terminated character string used to identify the client application name sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: DB2 for z/OS and OS/390 servers support up to a length of 32 characters. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>wrkstnname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_WRKSTNNAME</i> - A pointer to a null-terminated character string used to identify the client workstation name sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: DB2 for z/OS and OS/390 servers support up to a length of 18 characters. <br /> </p></blockquote><p> </p> </dd> </dl> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An integer value that specifies the type of resource that was passed into the function. The type of resource and this value must correspond. </p> <p class='para'> Passing <i>1</i> as the value specifies that a connection resource has been passed into the function. </p> <p class='para'> Passing any integer not equal to <i>1</i> as the value specifies that a statement resource has been passed into the function. </p> </dd> </dl> <p> </p> <p class='para'> </p> <p class='para'> The following table specifies which options are compatible with the available resource types: </p><table class='doctable table'> <caption><b>Resource-Parameter Matrix</b></caption> <col align='center' /> <col align='center' /> <col align='center' /> <col align='center' /> <col align='center' /> <thead valign='middle'> <tr valign='middle'> <th>Key</th> <th>Value</th> <th colspan='3'>Resource Type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td class='empty'>&amp;nbsp;</td><td class='empty'>&amp;nbsp;</td><td align='center'>Connection</td> <td align='center'>Statement</td> <td align='center'>Result Set</td> </tr> <tr valign='middle'> <td align='left'>autocommit</td> <td align='left'><i>DB2_AUTOCOMMIT_ON</i></td> <td align='center'>X</td> <td align='center'>-</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>autocommit</td> <td align='left'><i>DB2_AUTOCOMMIT_OFF</i></td> <td align='center'>X</td> <td align='center'>-</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>cursor</td> <td align='left'><i>DB2_SCROLLABLE</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>cursor</td> <td align='left'><i>DB2_FORWARD_ONLY</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>binmode</td> <td align='left'><i>DB2_BINARY</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>binmode</td> <td align='left'><i>DB2_CONVERT</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>binmode</td> <td align='left'><i>DB2_PASSTHRU</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>db2_attr_case</td> <td align='left'><i>DB2_CASE_LOWER</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>db2_attr_case</td> <td align='left'><i>DB2_CASE_UPPER</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>db2_attr_case</td> <td align='left'><i>DB2_CASE_NATURAL</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>deferred_prepare</td> <td align='left'><i>DB2_DEFERRED_PREPARE_ON</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>deferred_prepare</td> <td align='left'><i>DB2_DEFERRED_PREPARE_OFF</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>i5_fetch_only</td> <td align='left'><i>DB2_I5_FETCH_ON</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>i5_fetch_only</td> <td align='left'><i>DB2_I5_FETCH_OFF</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>rowcount</td> <td align='left'><i>DB2_ROWCOUNT_PREFETCH_ON</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>rowcount</td> <td align='left'><i>DB2_ROWCOUNT_PREFETCH_OFF</i></td> <td align='center'>-</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>trusted_user</td> <td align='left'><i>&amp;lt;USER NAME&amp;gt; (String)</i></td> <td align='center'>X</td> <td align='center'>-</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>trusted_password</td> <td align='left'><i>&amp;lt;PASSWORD&amp;gt; (String)</i></td> <td align='center'>X</td> <td align='center'>-</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>userid</td> <td align='left'><i>SQL_ATTR_INFO_USERID</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>acctstr</td> <td align='left'><i>SQL_ATTR_INFO_ACCTSTR</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>applname</td> <td align='left'><i>SQL_ATTR_INFO_APPLNAME</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>wrkstnname</td> <td align='left'><i>SQL_ATTR_INFO_WRKSTNNAME</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-set-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-set-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Setting one parameter with a connection resource</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_ON</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Options Set Successfully</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #2 Setting multiple parameters with a connection resource</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'binmode'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_PASSTHRU</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_UPPER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Options Set Successfully</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #3 Setting multiple parameters with an invalid key</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'MY_INVALID_KEY'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_PASSTHRU</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_UPPER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Could Not Set Options</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #4 Setting multiple parameters with an invalid value</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'binmode'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'INVALID_VALUE'</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_UPPER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Could Not Set Options</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #5 Setting multiple parameters with a connection resource and the wrong type</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'binmode'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_PASSTHRU</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_UPPER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;the&amp;nbsp;wrong&amp;nbsp;type&amp;nbsp;value&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Could Not Set Options</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #6 Setting multiple parameters with the wrong resource</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'binmode'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_PASSTHRU</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_UPPER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;EMPLOYEE'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;wrong&amp;nbsp;resource,&amp;nbsp;and&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Check&amp;nbsp;if&amp;nbsp;all&amp;nbsp;options&amp;nbsp;could&amp;nbsp;be&amp;nbsp;set&amp;nbsp;correctly&amp;nbsp;*/<br /></span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Options&amp;nbsp;Set&amp;nbsp;Successfully'</span><span style='color: #007700'>;<br />}<br />else<br />{<br />&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Could&amp;nbsp;Not&amp;nbsp;Set&amp;nbsp;Options'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Could Not Set Options</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #7 Putting it all together</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$protocol&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'TCPIP'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Connection&amp;nbsp;String&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=</span><span style='color: #0000BB'>$protocol</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #DD0000'>'UID=</span><span style='color: #0000BB'>$username</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'db2_attr_case'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_CASE_LOWER</span><span style='color: #007700'>,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;EMPLOYEE&amp;nbsp;WHERE&amp;nbsp;EMPNO&amp;nbsp;=&amp;nbsp;?&amp;nbsp;OR&amp;nbsp;EMPNO&amp;nbsp;=&amp;nbsp;?'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Call&amp;nbsp;the&amp;nbsp;function&amp;nbsp;using&amp;nbsp;the&amp;nbsp;correct&amp;nbsp;resource,&amp;nbsp;options&amp;nbsp;array,&amp;nbsp;and&amp;nbsp;type&amp;nbsp;values&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$option_result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'000130'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'000140'</span><span style='color: #007700'>));<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Get&amp;nbsp;Row&amp;nbsp;2&amp;nbsp;before&amp;nbsp;Row&amp;nbsp;1&amp;nbsp;since&amp;nbsp;Scrollable&amp;nbsp;Cursor&amp;nbsp;*/<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>db2_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>));<br />print&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;nbsp;/&amp;gt;&amp;lt;br&amp;nbsp;/&amp;gt;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>print_r</span><span style='color: #007700'>(</span><span style='color: #0000BB'>db2_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>Array ( [empno] =&amp;gt; 000140 [firstnme] =&amp;gt; HEATHER [midinit] =&amp;gt; A [lastname] =&amp;gt; NICHOLLS [workdept] =&amp;gt; C01 [phoneno] =&amp;gt; 1793 [hiredate] =&amp;gt; 1976-12-15 [job] =&amp;gt; ANALYST [edlevel] =&amp;gt; 18 [sex] =&amp;gt; F [birthdate] =&amp;gt; 1946-01-19 [salary] =&amp;gt; 28420.00 [bonus] =&amp;gt; 600.00 [comm] =&amp;gt; 2274.00 ) Array ( [empno] =&amp;gt; 000130 [firstnme] =&amp;gt; DELORES [midinit] =&amp;gt; M [lastname] =&amp;gt; QUINTANA [workdept] =&amp;gt; C01 [phoneno] =&amp;gt; 4578 [hiredate] =&amp;gt; 1971-07-28 [job] =&amp;gt; ANALYST [edlevel] =&amp;gt; 16 [sex] =&amp;gt; F [birthdate] =&amp;gt; 1925-09-15 [salary] =&amp;gt; 23800.00 [bonus] =&amp;gt; 500.00 [comm] =&amp;gt; 1904.00 )</pre></div></div> </div><p> </p><div class='example'> <p><b>Example #8 i5/OS cursors are read-only</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'i5_lib'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'nobody'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;names&amp;nbsp;where&amp;nbsp;first&amp;nbsp;=&amp;nbsp;?'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'first2'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'i5_fetch_only'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #0000BB'>DB2_I5_FETCH_ON</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>,</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> first2 last2 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-set-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-exec.php' class='function' rel='rdfs-seeAlso'>db2_exec()</a> - Executes an SQL statement directly</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-cursor-type.php' class='function' rel='rdfs-seeAlso'>db2_cursor_type()</a> - Returns the cursor type used by a statement resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_server_info" value="<div id='function.db2-server-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-server-info.php'>db2_server_info</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>db2_server_info</span> &amp;mdash; <span class='dc-title'>Returns an object with properties that describe the DB2 database server</span></p> </div> <a name='function.db2-server-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>db2_server_info</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> This function returns an object with read-only properties that return information about the IBM DB2, Cloudscape, or Apache Derby database server. The following table lists the database server properties: </p><table class='doctable table'> <caption><b>Database server properties</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Property name</th> <th>Return type</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>DBMS_NAME</td> <td align='left'>string</td> <td align='left'>The name of the database server to which you are connected. For DB2 servers this is a combination of <i>DB2</i> followed by the operating system on which the database server is running.</td> </tr> <tr valign='middle'> <td align='left'>DBMS_VER</td> <td align='left'>string</td> <td align='left'>The version of the database server, in the form of a string &amp;quot;MM.mm.uuuu&amp;quot; where <var class='varname'>MM</var> is the major version, <var class='varname'>mm</var> is the minor version, and <var class='varname'>uuuu</var> is the update. For example, &amp;quot;08.02.0001&amp;quot; represents major version 8, minor version 2, update 1. </td> </tr> <tr valign='middle'> <td align='left'>DB_CODEPAGE</td> <td align='left'>int</td> <td align='left'>The code page of the database to which you are connected.</td> </tr> <tr valign='middle'> <td align='left'>DB_NAME</td> <td align='left'>string</td> <td align='left'>The name of the database to which you are connected.</td> </tr> <tr valign='middle'> <td align='left'>DFT_ISOLATION</td> <td align='left'>string</td> <td align='left'> <p class='para'>The default transaction isolation level supported by the server: </p><dl> <dt class='varlistentry'> <span class='term'>UR</span> </dt><dd class='listitem'> <p class='para'> Uncommitted read: changes are immediately visible by all concurrent transactions. </p> </dd> <dt class='varlistentry'> <span class='term'>CS</span> </dt><dd class='listitem'> <p class='para'> Cursor stability: a row read by one transaction can be altered and committed by a second concurrent transaction. </p> </dd> <dt class='varlistentry'> <span class='term'>RS</span> </dt><dd class='listitem'> <p class='para'> Read stability: a transaction can add or remove rows matching a search condition or a pending transaction. </p> </dd> <dt class='varlistentry'> <span class='term'>RR</span> </dt><dd class='listitem'> <p class='para'> Repeatable read: data affected by pending transaction is not available to other transactions. </p> </dd> <dt class='varlistentry'> <span class='term'>NC</span> </dt><dd class='listitem'> <p class='para'> No commit: any changes are visible at the end of a successful operation. Explicit commits and rollbacks are not allowed. </p> </dd> </dl> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>IDENTIFIER_QUOTE_CHAR</td> <td align='left'>string</td> <td align='left'>The character used to delimit an identifier.</td> </tr> <tr valign='middle'> <td align='left'>INST_NAME</td> <td align='left'>string</td> <td align='left'>The instance on the database server that contains the database.</td> </tr> <tr valign='middle'> <td align='left'>ISOLATION_OPTION</td> <td align='left'>array</td> <td align='left'>An array of the isolation options supported by the database server. The isolation options are described in the DFT_ISOLATION property.</td> </tr> <tr valign='middle'> <td align='left'>KEYWORDS</td> <td align='left'>array</td> <td align='left'>An array of the keywords reserved by the database server.</td> </tr> <tr valign='middle'> <td align='left'>LIKE_ESCAPE_CLAUSE</td> <td align='left'>bool</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if the database server supports the use of <i>%</i> and <i>_</i> wildcard characters. <b><tt class='constant'>FALSE</tt></b> if the database server does not support these wildcard characters.</td> </tr> <tr valign='middle'> <td align='left'>MAX_COL_NAME_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of a column name supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_IDENTIFIER_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of an SQL identifier supported by the database server, expressed in characters.</td> </tr> <tr valign='middle'> <td align='left'>MAX_INDEX_SIZE</td> <td align='left'>int</td> <td align='left'>Maximum size of columns combined in an index supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_PROC_NAME_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of a procedure name supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_ROW_SIZE</td> <td align='left'>int</td> <td align='left'>Maximum length of a row in a base table supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_SCHEMA_NAME_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of a schema name supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_STATEMENT_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of an SQL statement supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>MAX_TABLE_NAME_LEN</td> <td align='left'>int</td> <td align='left'>Maximum length of a table name supported by the database server, expressed in bytes.</td> </tr> <tr valign='middle'> <td align='left'>NON_NULLABLE_COLUMNS</td> <td align='left'>bool</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if the database server supports columns that can be defined as NOT NULL, <b><tt class='constant'>FALSE</tt></b> if the database server does not support columns defined as NOT NULL.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURES</td> <td align='left'>bool</td> <td align='left'><b><tt class='constant'>TRUE</tt></b> if the database server supports the use of the CALL statement to call stored procedures, <b><tt class='constant'>FALSE</tt></b> if the database server does not support the CALL statement.</td> </tr> <tr valign='middle'> <td align='left'>SPECIAL_CHARS</td> <td align='left'>string</td> <td align='left'>A string containing all of the characters other than a-Z, 0-9, and underscore that can be used in an identifier name.</td> </tr> <tr valign='middle'> <td align='left'>SQL_CONFORMANCE</td> <td align='left'>string</td> <td align='left'> <p class='para'>The level of conformance to the ANSI/ISO SQL-92 specification offered by the database server: </p><dl> <dt class='varlistentry'> <span class='term'>ENTRY</span> </dt><dd class='listitem'> <p class='para'> Entry-level SQL-92 compliance. </p> </dd> <dt class='varlistentry'> <span class='term'>FIPS127</span> </dt><dd class='listitem'> <p class='para'> FIPS-127-2 transitional compliance. </p> </dd> <dt class='varlistentry'> <span class='term'>FULL</span> </dt><dd class='listitem'> <p class='para'> Full level SQL-92 compliance. </p> </dd> <dt class='varlistentry'> <span class='term'>INTERMEDIATE</span> </dt><dd class='listitem'> <p class='para'> Intermediate level SQL-92 compliance. </p> </dd> </dl> <p> </p> </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-server-info.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies an active DB2 client connection. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-server-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object on a successful call. Returns <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-server-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_server_info()</b> example</b></p> <div class='example-contents para'><p> To retrieve information about the server, you must pass a valid database connection resource to <b>db2_server_info()</b>. </p></div> <div class='example-contents programlisting'><div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'sample'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$server&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_server_info</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DBMS_NAME:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DBMS_NAME&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DBMS_VER:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DBMS_VER&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DB_CODEPAGE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DB_CODEPAGE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DB_NAME:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DB_NAME&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'INST_NAME:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>INST_NAME&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'SPECIAL_CHARS:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>SPECIAL_CHARS&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'KEYWORDS:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>sizeof</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>KEYWORDS</span><span style='color: #007700'>)&amp;nbsp;);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DFT_ISOLATION:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DFT_ISOLATION&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'ISOLATION_OPTION:&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$il&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ISOLATION_OPTION&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$opt&amp;nbsp;</span><span style='color: #007700'>)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$il&amp;nbsp;</span><span style='color: #007700'>.=&amp;nbsp;</span><span style='color: #0000BB'>$opt</span><span style='color: #007700'>.</span><span style='color: #DD0000'>'&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$il&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'SQL_CONFORMANCE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>SQL_CONFORMANCE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'PROCEDURES:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PROCEDURES&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'IDENTIFIER_QUOTE_CHAR:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>IDENTIFIER_QUOTE_CHAR&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'LIKE_ESCAPE_CLAUSE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>LIKE_ESCAPE_CLAUSE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_COL_NAME_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_COL_NAME_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_ROW_SIZE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_ROW_SIZE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_IDENTIFIER_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_IDENTIFIER_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_INDEX_SIZE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_INDEX_SIZE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_PROC_NAME_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_PROC_NAME_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_SCHEMA_NAME_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_SCHEMA_NAME_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_STATEMENT_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_STATEMENT_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'MAX_TABLE_NAME_LEN:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>MAX_TABLE_NAME_LEN&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'NON_NULLABLE_COLUMNS:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$server</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NON_NULLABLE_COLUMNS&amp;nbsp;</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div></div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'><div class='cdata'><pre>DBMS_NAME: string(9) &amp;quot;DB2/LINUX&amp;quot; DBMS_VER: string(10) &amp;quot;08.02.0000&amp;quot; DB_CODEPAGE: int(1208) DB_NAME: string(6) &amp;quot;SAMPLE&amp;quot; INST_NAME: string(8) &amp;quot;db2inst1&amp;quot; SPECIAL_CHARS: string(2) &amp;quot;@#&amp;quot; KEYWORDS: int(179) DFT_ISOLATION: string(2) &amp;quot;CS&amp;quot; ISOLATION_OPTION: string(12) &amp;quot;UR CS RS RR &amp;quot; SQL_CONFORMANCE: string(7) &amp;quot;FIPS127&amp;quot; PROCEDURES: bool(true) IDENTIFIER_QUOTE_CHAR: string(1) &amp;quot;&amp;quot;&amp;quot; LIKE_ESCAPE_CLAUSE: bool(true) MAX_COL_NAME_LEN: int(30) MAX_ROW_SIZE: int(32677) MAX_IDENTIFIER_LEN: int(18) MAX_INDEX_SIZE: int(1024) MAX_PROC_NAME_LEN: int(128) MAX_SCHEMA_NAME_LEN: int(30) MAX_STATEMENT_LEN: int(2097152) MAX_TABLE_NAME_LEN: int(128) NON_NULLABLE_COLUMNS: bool(true)</pre></div></div> </div><p> </p> </div> <a name='function.db2-server-info.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-client-info.php' class='function' rel='rdfs-seeAlso'>db2_client_info()</a> - Returns an object with properties that describe the DB2 database client</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_rollback" value="<div id='function.db2-rollback' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-rollback.php'>db2_rollback</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_rollback</span> &amp;mdash; <span class='dc-title'> Rolls back a transaction </span></p> </div> <a name='function.db2-rollback.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_rollback</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Rolls back an in-progress transaction on the specified connection resource and begins a new transaction. PHP applications normally default to AUTOCOMMIT mode, so <b>db2_rollback()</b> normally has no effect unless AUTOCOMMIT has been turned off for the connection resource. </p> <blockquote><p><b class='note'>Note</b>: If the specified connection resource is a persistent connection, all transactions in progress for all applications using that persistent connection will be rolled back. For this reason, persistent connections are not recommended for use in applications that require transactions. <br /> </p></blockquote> </div> <a name='function.db2-rollback.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid database connection resource variable as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-rollback.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-rollback.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Rolling back a DELETE statement</b></p> <div class='example-contents para'><p> In the following example, we count the number of rows in a table, turn off AUTOCOMMIT mode on a database connection, delete all of the rows in the table and return the count of <i>0</i> to prove that the rows have been removed. We then issue <b>db2_rollback()</b> and return the updated count of rows in the table to show that the number is the same as before we issued the DELETE statement. The return to the original state of the table demonstrates that the roll back of the transaction succeeded. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;count(*)&amp;nbsp;FROM&amp;nbsp;animals'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Turn&amp;nbsp;AUTOCOMMIT&amp;nbsp;off<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Delete&amp;nbsp;all&amp;nbsp;rows&amp;nbsp;from&amp;nbsp;ANIMALS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'DELETE&amp;nbsp;FROM&amp;nbsp;animals'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;count(*)&amp;nbsp;FROM&amp;nbsp;animals'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//&amp;nbsp;Roll&amp;nbsp;back&amp;nbsp;the&amp;nbsp;DELETE&amp;nbsp;statement<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_rollback</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;count(*)&amp;nbsp;FROM&amp;nbsp;animals'&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 7 0 7 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-rollback.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-autocommit.php' class='function' rel='rdfs-seeAlso'>db2_autocommit()</a> - Returns or sets the AUTOCOMMIT state for a database connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-commit.php' class='function' rel='rdfs-seeAlso'>db2_commit()</a> - Commits a transaction</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_result" value="<div id='function.db2-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-result.php'>db2_result</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_result</span> &amp;mdash; <span class='dc-title'> Returns a single column from a row in the result set </span></p> </div> <a name='function.db2-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>db2_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Use <b>db2_result()</b> to return the value of a specified column in the current row of a result set. You must call <a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function'>db2_fetch_row()</a> before calling <b>db2_result()</b> to set the location of the result set pointer. </p> </div> <a name='function.db2-result.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Either an integer mapping to the 0-indexed field in the result set, or a string matching the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the value of the requested field if the field exists in the result set. Returns NULL if the field does not exist, and issues a warning. </p> </div> <a name='function.db2-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_result()</b> example</b></p> <div class='example-contents para'><p> The following example demonstrates how to iterate through a result set with <a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function'>db2_fetch_row()</a> and retrieve columns from the result set with <b>db2_result()</b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;name,&amp;nbsp;breed&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;WHERE&amp;nbsp;weight&amp;nbsp;&amp;lt;&amp;nbsp;?'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>));<br />while&amp;nbsp;(</span><span style='color: #0000BB'>db2_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$breed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'BREED'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$name</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #0000BB'>$breed</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> cat Pook gold fish Bubbles budgerigar Gizmo goat Rickety Ride </pre></div> </div> </div><p> </p> </div> <a name='function.db2-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function' rel='rdfs-seeAlso'>db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_procedures" value="<div id='function.db2-procedures' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-procedures.php'>db2_procedures</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_procedures</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the stored procedures registered in a database </span></p> </div> <a name='function.db2-procedures.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_procedures</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$procedure</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the stored procedures registered in a database. </p> </div> <a name='function.db2-procedures.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the procedures. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>procedure</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the procedure. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-procedures.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the stored procedures matching the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>PROCEDURE_CAT</td> <td align='left'>The catalog that contains the procedure. The value is <b><tt class='constant'>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURE_SCHEM</td> <td align='left'>Name of the schema that contains the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURE_NAME</td> <td align='left'>Name of the procedure.</td> </tr> <tr valign='middle'> <td align='left'>NUM_INPUT_PARAMS</td> <td align='left'>Number of input (IN) parameters for the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>NUM_OUTPUT_PARAMS</td> <td align='left'>Number of output (OUT) parameters for the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>NUM_RESULT_SETS</td> <td align='left'>Number of result sets returned by the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>REMARKS</td> <td align='left'>Any comments about the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURE_TYPE</td> <td align='left'>Always returns <i>1</i>, indicating that the stored procedure does not return a return value.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-procedures.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_procedure_columns" value="<div id='function.db2-procedure-columns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-procedure-columns.php'>db2_procedure_columns</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_procedure_columns</span> &amp;mdash; <span class='dc-title'> Returns a result set listing stored procedure parameters </span></p> </div> <a name='function.db2-procedure-columns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_procedure_columns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$procedure</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$parameter</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the parameters for one or more stored procedures. </p> </div> <a name='function.db2-procedure-columns.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the procedures. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>procedure</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the procedure. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>parameter</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the parameter. This parameter accepts a search pattern containing <i>_</i> and <i>%</i> as wildcards. If this parameter is <b><tt class='constant'>NULL</tt></b>, all parameters for the specified stored procedures are returned. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-procedure-columns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the parameters for the stored procedures matching the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>PROCEDURE_CAT</td> <td align='left'>The catalog that contains the procedure. The value is <b><tt class='constant'>NULL</tt></b> if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURE_SCHEM</td> <td align='left'>Name of the schema that contains the stored procedure.</td> </tr> <tr valign='middle'> <td align='left'>PROCEDURE_NAME</td> <td align='left'>Name of the procedure.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>Name of the parameter.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_TYPE</td> <td align='left'> <p class='para'> An integer value representing the type of the parameter: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Return value</th> <th>Parameter type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>1 (SQL_PARAM_INPUT)</td> <td align='left'>Input (IN) parameter.</td> </tr> <tr valign='middle'> <td align='left'>2 (SQL_PARAM_INPUT_OUTPUT)</td> <td align='left'>Input/output (INOUT) parameter.</td> </tr> <tr valign='middle'> <td align='left'>3 (SQL_PARAM_OUTPUT)</td> <td align='left'>Output (OUT) parameter.</td> </tr> </tbody> </table> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>DATA_TYPE</td> <td align='left'>The SQL data type for the parameter represented as an integer value.</td> </tr> <tr valign='middle'> <td align='left'>TYPE_NAME</td> <td align='left'>A string representing the data type for the parameter.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_SIZE</td> <td align='left'>An integer value representing the size of the parameter.</td> </tr> <tr valign='middle'> <td align='left'>BUFFER_LENGTH</td> <td align='left'> Maximum number of bytes necessary to store data for this parameter. </td> </tr> <tr valign='middle'> <td align='left'>DECIMAL_DIGITS</td> <td align='left'> The scale of the parameter, or <b><tt class='constant'>NULL</tt></b> where scale is not applicable. </td> </tr> <tr valign='middle'> <td align='left'>NUM_PREC_RADIX</td> <td align='left'> An integer value of either <i>10</i> (representing an exact numeric data type), <i>2</i> (representing an approximate numeric data type), or <b><tt class='constant'>NULL</tt></b> (representing a data type for which radix is not applicable). </td> </tr> <tr valign='middle'> <td align='left'>NULLABLE</td> <td align='left'>An integer value representing whether the parameter is nullable or not.</td> </tr> <tr valign='middle'> <td align='left'>REMARKS</td> <td align='left'>Description of the parameter.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_DEF</td> <td align='left'>Default value for the parameter.</td> </tr> <tr valign='middle'> <td align='left'>SQL_DATA_TYPE</td> <td align='left'>An integer value representing the size of the parameter.</td> </tr> <tr valign='middle'> <td align='left'>SQL_DATETIME_SUB</td> <td align='left'> Returns an integer value representing a datetime subtype code, or <b><tt class='constant'>NULL</tt></b> for SQL data types to which this does not apply. </td> </tr> <tr valign='middle'> <td align='left'>CHAR_OCTET_LENGTH</td> <td align='left'> Maximum length in octets for a character data type parameter, which matches COLUMN_SIZE for single-byte character set data, or <b><tt class='constant'>NULL</tt></b> for non-character data types. </td> </tr> <tr valign='middle'> <td align='left'>ORDINAL_POSITION</td> <td align='left'>The 1-indexed position of the parameter in the CALL statement.</td> </tr> <tr valign='middle'> <td align='left'>IS_NULLABLE</td> <td align='left'> A string value where &amp;#039;YES&amp;#039; means that the parameter accepts or returns <b><tt class='constant'>NULL</tt></b> values and &amp;#039;NO&amp;#039; means that the parameter does not accept or return <b><tt class='constant'>NULL</tt></b> values. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-procedure-columns.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_primary_keys" value="<div id='function.db2-primary-keys' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-primary-keys.php'>db2_primary_keys</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_primary_keys</span> &amp;mdash; <span class='dc-title'> Returns a result set listing primary keys for a table </span></p> </div> <a name='function.db2-primary-keys.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_primary_keys</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the primary keys for a table. </p> </div> <a name='function.db2-primary-keys.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. If <i><tt class='parameter'>schema</tt></i> is <b><tt class='constant'>NULL</tt></b>, <b>db2_primary_keys()</b> matches the schema for the current connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-primary-keys.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the primary keys for the specified table. The result set is composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'> Name of the catalog for the table containing the primary key. The value is NULL if this table does not have catalogs. </td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'> Name of the schema for the table containing the primary key. </td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table containing the primary key.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>Name of the column containing the primary key.</td> </tr> <tr valign='middle'> <td align='left'>KEY_SEQ</td> <td align='left'>1-indexed position of the column in the key.</td> </tr> <tr valign='middle'> <td align='left'>PK_NAME</td> <td align='left'>The name of the primary key.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-primary-keys.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_prepare" value="<div id='function.db2-prepare' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-prepare.php'>db2_prepare</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_prepare</span> &amp;mdash; <span class='dc-title'> Prepares an SQL statement to be executed </span></p> </div> <a name='function.db2-prepare.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_prepare</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$statement</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$options</tt></span> ] )</div> <p class='para rdfs-comment'> <b>db2_prepare()</b> creates a prepared SQL statement which can include 0 or more parameter markers (<i>?</i> characters) representing parameters for input, output, or input/output. You can pass parameters to the prepared statement using <a href='http://www.php.net/manual/en/function.db2-bind-param.php' class='function'>db2_bind_param()</a>, or for input values only, as an array passed to <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a>. </p> <p class='para'> There are three main advantages to using prepared statements in your application: </p><ul class='itemizedlist'> <li class='listitem'> <p class='para'> <em class='emphasis'>Performance</em>: when you prepare a statement, the database server creates an optimized access plan for retrieving data with that statement. Subsequently issuing the prepared statement with <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a> enables the statements to reuse that access plan and avoids the overhead of dynamically creating a new access plan for every statement you issue. </p> </li> <li class='listitem'> <p class='para'> <em class='emphasis'>Security</em>: when you prepare a statement, you can include parameter markers for input values. When you execute a prepared statement with input values for placeholders, the database server checks each input value to ensure that the type matches the column definition or parameter definition. </p> </li> <li class='listitem'> <p class='para'> <em class='emphasis'>Advanced functionality</em>: Parameter markers not only enable you to pass input values to prepared SQL statements, they also enable you to retrieve OUT and INOUT parameters from stored procedures using <a href='http://www.php.net/manual/en/function.db2-bind-param.php' class='function'>db2_bind_param()</a>. </p> </li> </ul><p> </p> </div> <a name='function.db2-prepare.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid database connection resource variable as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An SQL statement, optionally containing one or more parameter markers.. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array containing statement options. You can use this parameter to request a scrollable cursor on database servers that support this functionality. </p> <p class='para'> For a description of valid statement options, see <a href='http://www.php.net/manual/en/function.db2-set-option.php' class='function'>db2_set_option()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-prepare.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource if the SQL statement was successfully parsed and prepared by the database server. Returns <b><tt class='constant'>FALSE</tt></b> if the database server returned an error. You can determine which error was returned by calling <a href='http://www.php.net/manual/en/function.db2-stmt-error.php' class='function'>db2_stmt_error()</a> or <a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function'>db2_stmt_errormsg()</a>. </p> </div> <a name='function.db2-prepare.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Preparing and executing an SQL statement with parameter markers</b></p> <div class='example-contents para'><p> The following example prepares an INSERT statement that accepts four parameter markers, then iterates over an array of arrays containing the input values to be passed to <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$animals&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cat'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Pook'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3.2</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'dog'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Peaches'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>12.3</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'horse'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Smarty'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>350.0</span><span style='color: #007700'>),<br />);<br /><br /></span><span style='color: #0000BB'>$insert&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;animals&amp;nbsp;(id,&amp;nbsp;breed,&amp;nbsp;name,&amp;nbsp;weight)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;VALUES&amp;nbsp;(?,&amp;nbsp;?,&amp;nbsp;?,&amp;nbsp;?)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$insert</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach&amp;nbsp;(</span><span style='color: #0000BB'>$animals&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.db2-prepare.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-bind-param.php' class='function' rel='rdfs-seeAlso'>db2_bind_param()</a> - Binds a PHP variable to an SQL statement parameter</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-execute.php' class='function' rel='rdfs-seeAlso'>db2_execute()</a> - Executes a prepared SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-error.php' class='function' rel='rdfs-seeAlso'>db2_stmt_error()</a> - Returns a string containing the SQLSTATE returned by an SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_stmt_errormsg()</a> - Returns a string containing the last SQL statement error message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_pconnect" value="<div id='function.db2-pconnect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-pconnect.php'>db2_pconnect</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_pconnect</span> &amp;mdash; <span class='dc-title'> Returns a persistent connection to a database </span></p> </div> <a name='function.db2-pconnect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_pconnect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$options</tt></span> ] )</div> <p class='para rdfs-comment'> Returns a persistent connection to an IBM DB2 Universal Database, IBM Cloudscape, or Apache Derby database. For more information on persistent connections, refer to <a href='http://www.php.net/manual/en/features.persistent-connections.php' class='xref'>Persistent Database Connections</a>. </p> <p class='para'> Calling <a href='http://www.php.net/manual/en/function.db2-close.php' class='function'>db2_close()</a> on a persistent connection always returns <b><tt class='constant'>TRUE</tt></b>, but the underlying DB2 client connection remains open and waiting to serve the next matching <b>db2_pconnect()</b> request. </p> </div> <a name='function.db2-pconnect.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'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The database alias in the DB2 client catalog. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username with which you are connecting to the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password with which you are connecting to the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array of connection options that affect the behavior of the connection, where valid array keys include: </p><dl> <dt class='varlistentry'> <br /><span class='term'><i><tt class='parameter'>autocommit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_AUTOCOMMIT_ON</i> value turns autocommit on for this connection handle. </p> <p class='para'> Passing the <i>DB2_AUTOCOMMIT_OFF</i> value turns autocommit off for this connection handle. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>DB2_ATTR_CASE</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_CASE_NATURAL</i> value specifies that column names are returned in natural case. </p> <p class='para'> Passing the <i>DB2_CASE_LOWER</i> value specifies that column names are returned in lower case. </p> <p class='para'> Passing the <i>DB2_CASE_UPPER</i> value specifies that column names are returned in upper case. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>CURSOR</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_FORWARD_ONLY</i> value specifies a forward-only cursor for a statement resource. This is the default cursor type and is supported on all database servers. </p> <p class='para'> Passing the <i>DB2_SCROLLABLE</i> value specifies a scrollable cursor for a statement resource. This mode enables random access to rows in a result set, but currently is supported only by IBM DB2 Universal Database. </p> </dd> </dl> <p> </p> <p class='para'> The following new option is available in ibm_db2 version 1.7.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>trustedcontext</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context on for this connection handle. This parameter cannot be set using <a href='http://www.php.net/manual/en/function.db2-set-option.php' class='function'>db2_set_option()</a>. </p> <p class='para'> This key works only if the database is cataloged (even if the database is local), or if you specify the full DSN when you create the connection. </p> <p class='para'> To catalog the database, use following commands: </p> <p class='para'> <pre class='literallayout'>db2 catalog tcpip node loopback remote &amp;lt;SERVERNAME&amp;gt; server &amp;lt;SERVICENAME&amp;gt; db2 catalog database &amp;lt;LOCALDBNAME&amp;gt; as &amp;lt;REMOTEDBNAME&amp;gt; at node loopback db2 &amp;quot;update dbm cfg using svcename &amp;lt;SERVICENAME&amp;gt;&amp;quot; db2set DB2COMM=TCPIP</pre> </p> </dd> </dl> <p> </p> <p class='para'> The following new i5/OS options are available in ibm_db2 version 1.5.1 and later. <div class='tip'><b class='tip'>Tip</b> <p class='para'>Conflicting connection attributes used in conjunction with persistent connections can produce indeterminate results on i5/OS. Site policies should be establish for all applications using each persistent connection user profile. The default DB2_AUTOCOMMIT_ON is suggested when using persistent connections. </p> </div> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_lib</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A character value that indicates the default library that will be used for resolving unqualified file references. This is not valid if the connection is using system naming mode. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_naming</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_NAMING_ON</i> value turns on DB2 UDB CLI iSeries system naming mode. Files are qualified using the slash (/) delimiter. Unqualified files are resolved using the library list for the job. </p> <p class='para'> <i>DB2_I5_NAMING_OFF</i> value turns off DB2 UDB CLI default naming mode, which is SQL naming. Files are qualified using the period (.) delimiter. Unqualified files are resolved using either the default library or the current user ID. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_commit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>i5_commit</tt></i> attribute should be set before the <b>db2_pconnect()</b>. If the value is changed after the connection has been established, and the connection is to a remote data source, the change does not take effect until the next successful <b>db2_pconnect()</b> for the connection handle. </p><blockquote><p><b class='note'>Note</b>: The php.ini setting <i><tt class='parameter'>ibm_db2.i5_allow_commit</tt></i> ==0 or <i>DB2_I5_TXN_NO_COMMIT</i> is the default, but may be overridden with the <i><tt class='parameter'>i5_commit</tt></i> option. <br /> </p></blockquote><p> </p> <p class='para'> <i>DB2_I5_TXN_NO_COMMIT</i> - Commitment control is not used. </p> <p class='para'> <i>DB2_I5_TXN_READ_UNCOMMITTED</i> - Dirty reads, nonrepeatable reads, and phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_READ_COMMITTED</i> - Dirty reads are not possible. Nonrepeatable reads, and phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_REPEATABLE_READ</i> - Dirty reads and nonrepeatable reads are not possible. Phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_SERIALIZABLE</i> - Transactions are serializable. Dirty reads, non-repeatable reads, and phantoms are not possible </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_query_optimize</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_FIRST_IO</i> All queries are optimized with the goal of returning the first page of output as fast as possible. This goal works well when the output is controlled by a user who is most likely to cancel the query after viewing the first page of output data. Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. </p> <p class='para'> <i>DB2_ALL_IO</i> All queries are optimized with the goal of running the entire query to completion in the shortest amount of elapsed time. This is a good option when the output of a query is being written to a file or report, or the interface is queuing the output data. Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. This is the default. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_dbcs_alloc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_DBCS_ALLOC_ON</i> value turns on DB2 6X allocation scheme for DBCS translation column size growth. </p> <p class='para'> <i>DB2_I5_DBCS_ALLOC_OFF</i> value turns off DB2 6X allocation scheme for DBCS translation column size growth. </p><blockquote><p><b class='note'>Note</b>: The php.ini setting <i><tt class='parameter'>ibm_db2.i5_dbcs_alloc</tt></i> ==0 or <i>DB2_I5_DBCS_ALLOC_OFF</i> is the default, but may be overridden with the <i><tt class='parameter'>i5_dbcs_alloc</tt></i> option. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_date_fmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_FMT_ISO</i> - The International Organization for Standardization (ISO) date format yyyy-mm-dd is used. This is the default. </p> <p class='para'> <i>DB2_I5_FMT_USA</i> - The United States date format mm/dd/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_EUR</i> - The European date format dd.mm.yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_JIS</i> - The Japanese Industrial Standard date format yyyy-mm-dd is used. </p> <p class='para'> <i>DB2_I5_FMT_MDY</i> - The date format mm/dd/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_DMY</i> - The date format dd/mm/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_YMD</i> - The date format yy/mm/dd is used. </p> <p class='para'> <i>DB2_I5_FMT_JUL</i> - The Julian date format yy/ddd is used. </p> <p class='para'> <i>DB2_I5_FMT_JOB</i> - The job default is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_date_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_SLASH</i> - A slash ( / ) is used as the date separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_DASH</i> - A dash ( - ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_BLANK</i> - A blank is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_time_fmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_FMT_ISO</i> - The International Organization for Standardization (ISO) time format hh.mm.ss is used. This is the default. </p> <p class='para'> <i>DB2_I5_FMT_USA</i> - The United States time format hh:mmxx is used, where xx is AM or PM. </p> <p class='para'> <i>DB2_I5_FMT_EUR</i> - The European time format hh.mm.ss is used. </p> <p class='para'> <i>DB2_I5_FMT_JIS</i> - The Japanese Industrial Standard time format hh:mm:ss is used. </p> <p class='para'> <i>DB2_I5_FMT_HMS</i> - The hh:mm:ss format is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_time_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_COLON</i> - A colon ( : ) is used as the time separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_BLANK</i> - A blank is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_decimal_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the decimal separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the decimal separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used. </p> </dd> </dl> <p> </p> <p class='para'> The following new i5/OS option is available in ibm_db2 version 1.8.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_libl</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A character value that indicates the library list that will be used for resolving unqualified file references. Specify the library list elements separated by blanks &amp;#039;i5_libl&amp;#039;=&amp;gt;&amp;quot;MYLIB YOURLIB ANYLIB&amp;quot;. </p><blockquote><p><b class='note'>Note</b>: i5_libl calls qsys2/qcmdexc(&amp;#039;cmd&amp;#039;,cmdlen), which is only available in i5/OS V5R4 and later. <br /> </p></blockquote><p> </p> </dd> </dl> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.db2-pconnect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a connection handle resource if the connection attempt is successful. <b>db2_pconnect()</b> tries to reuse an existing connection resource that exactly matches the <i><tt class='parameter'>database</tt></i> , <i><tt class='parameter'>username</tt></i> , and <i><tt class='parameter'>password</tt></i> parameters. If the connection attempt fails, <b>db2_pconnect()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-pconnect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_pconnect()</b> example</b></p> <div class='example-contents para'><p> In the following example, the first call to <b>db2_pconnect()</b> returns a new persistent connection resource. The second call to <b>db2_pconnect()</b> returns a persistent connection resource that simply reuses the first persistent connection resource. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$pconn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_pconnect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pconn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Persistent&amp;nbsp;connection&amp;nbsp;succeeded.'</span><span style='color: #007700'>;<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Persistent&amp;nbsp;connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #0000BB'>$pconn2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_pconnect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$pconn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Second&amp;nbsp;persistent&amp;nbsp;connection&amp;nbsp;succeeded.'</span><span style='color: #007700'>;<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Second&amp;nbsp;persistent&amp;nbsp;connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Persistent connection succeeded. Second persistent connection succeeded. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Using trusted context</b></p> <div class='example-contents para'><p> The following example shows how to enable trusted context, switch users, and get the current user ID. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$authID&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$auth_pass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tc_user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'tcuser'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$tc_pass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'tcpassword'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$dsn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;<br />&amp;nbsp;&amp;nbsp;PROTOCOL=TCPIP;UID=</span><span style='color: #0000BB'>$authID</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$auth_pass</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array&amp;nbsp;(</span><span style='color: #DD0000'>'trustedcontext'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_TRUSTED_CONTEXT_ENABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tc_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_pconnect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dsn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>);<br />if(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Explicit&amp;nbsp;trusted&amp;nbsp;connection&amp;nbsp;succeeded.\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trustedcontext'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$userBefore&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trusted_user'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//Do&amp;nbsp;some&amp;nbsp;work&amp;nbsp;as&amp;nbsp;user&amp;nbsp;1.<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//Switching&amp;nbsp;to&amp;nbsp;trusted&amp;nbsp;user.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$parameters&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'trusted_user'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$tc_user</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'trusted_password'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$tcuser_pass</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$parameters</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$userAfter&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trusted_user'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//Do&amp;nbsp;more&amp;nbsp;work&amp;nbsp;as&amp;nbsp;trusted&amp;nbsp;user.<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$userBefore&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>$userAfter</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;has&amp;nbsp;been&amp;nbsp;switched.'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Explicit&amp;nbsp;trusted&amp;nbsp;connection&amp;nbsp;failed.\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Explicit trusted connection succeeded. User has been switched. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-pconnect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_pclose" value="<div id='function.db2-pclose' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-pclose.php'>db2_pclose</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.8.0)</p><p class='refpurpose'><span class='refname'>db2_pclose</span> &amp;mdash; <span class='dc-title'>Closes a persistent database connection</span></p> </div> <a name='function.db2-pclose.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_pclose</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$resource</tt></span> )</div> <p class='para rdfs-comment'> This function closes a DB2 client connection created with <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a> and returns the corresponding resources to the database server. </p><blockquote><p><b class='note'>Note</b>: This function is only available on i5/OS in response to i5/OS system administration requests. <br /> </p></blockquote><p> </p> <p class='para'> If you have a persistent DB2 client connection created with <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>, you may use this function to close the connection. To avoid substantial connection performance penalties, this function should only be used in rare cases when the persistent connection has become unresponsive or the persistent connection will not be needed for a long period of time. </p> </div> <a name='function.db2-pclose.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies an active DB2 client connection. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-pclose.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-pclose.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Closing a persistent connection</b></p> <div class='example-contents para'><p> The following example demonstrates a successful attempt to close a connection to an IBM DB2 i5/OS database. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_pconnect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_pclose</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$rc</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;was&amp;nbsp;successfully&amp;nbsp;closed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connection was successfully closed. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-pclose.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-close.php' class='function' rel='rdfs-seeAlso'>db2_close()</a> - Closes a database connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_num_rows" value="<div id='function.db2-num-rows' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-num-rows.php'>db2_num_rows</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_num_rows</span> &amp;mdash; <span class='dc-title'> Returns the number of rows affected by an SQL statement </span></p> </div> <a name='function.db2-num-rows.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>db2_num_rows</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of rows deleted, inserted, or updated by an SQL statement. </p> <p class='para'> To determine the number of rows that will be returned by a SELECT statement, issue SELECT COUNT(*) with the same predicates as your intended SELECT statement and retrieve the value. </p> <p class='para'> If your application logic checks the number of rows returned by a SELECT statement and branches if the number of rows is 0, consider modifying your application to attempt to return the first row with one of <a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function'>db2_fetch_assoc()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function'>db2_fetch_both()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a>, or <a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function'>db2_fetch_row()</a>, and branch if the fetch function returns <b><tt class='constant'>FALSE</tt></b>. </p> <blockquote><p><b class='note'>Note</b>: If you issue a SELECT statement using a scrollable cursor, <b>db2_num_rows()</b> returns the number of rows returned by the SELECT statement. However, the overhead associated with scrollable cursors significantly degrades the performance of your application, so if this is the only reason you are considering using scrollable cursors, you should use a forward-only cursor and either call SELECT COUNT(*) or rely on the <a href='http://www.php.net/manual/en/language.types.boolean.php' class='type boolean'>boolean</a> return value of the fetch functions to achieve the equivalent functionality with much better performance. <br /> </p></blockquote> </div> <a name='function.db2-num-rows.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing a result set. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-num-rows.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the number of rows affected by the last SQL statement issued by the specified statement handle. </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_num_fields" value="<div id='function.db2-num-fields' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-num-fields.php'>db2_num_fields</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_num_fields</span> &amp;mdash; <span class='dc-title'> Returns the number of fields contained in a result set </span></p> </div> <a name='function.db2-num-fields.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>db2_num_fields</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the number of fields contained in a result set. This is most useful for handling the result sets returned by dynamically generated queries, or for result sets returned by stored procedures, where your application cannot otherwise know how to retrieve and use the results. </p> </div> <a name='function.db2-num-fields.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource containing a result set. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-num-fields.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer value representing the number of fields in the result set associated with the specified statement resource. Returns <b><tt class='constant'>FALSE</tt></b> if the statement resource is not a valid input value. </p> </div> <a name='function.db2-num-fields.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Retrieving the number of fields in a result set</b></p> <div class='example-contents para'><p> The following example demonstrates how to retrieve the number of fields returned in a result set. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$columns&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_num_fields</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'There&amp;nbsp;are&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$columns</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;columns&amp;nbsp;in&amp;nbsp;the&amp;nbsp;result&amp;nbsp;set.'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> There are 4 columns in the result set. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-num-fields.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-execute.php' class='function' rel='rdfs-seeAlso'>db2_execute()</a> - Executes a prepared SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_next_result" value="<div id='function.db2-next-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-next-result.php'>db2_next_result</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_next_result</span> &amp;mdash; <span class='dc-title'> Requests the next result set from a stored procedure </span></p> </div> <a name='function.db2-next-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_next_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> A stored procedure can return zero or more result sets. While you handle the first result set in exactly the same way you would handle the results returned by a simple SELECT statement, to fetch the second and subsequent result sets from a stored procedure you must call the <b>db2_next_result()</b> function and return the result to a uniquely named PHP variable. </p> </div> <a name='function.db2-next-result.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A prepared statement returned from <a href='http://www.php.net/manual/en/function.db2-exec.php' class='function'>db2_exec()</a> or <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-next-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a new statement resource containing the next result set if the stored procedure returned another result set. Returns <b><tt class='constant'>FALSE</tt></b> if the stored procedure did not return another result set. </p> </div> <a name='function.db2-next-result.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Calling a stored procedure that returns multiple result sets</b></p> <div class='example-contents para'><p> In the following example, we call a stored procedure that returns three result sets. The first result set is fetched directly from the same statement resource on which we invoked the CALL statement, while the second and third result sets are fetched from statement resources returned from our calls to the <b>db2_next_result()</b> function. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CALL&amp;nbsp;multiResults()'</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Fetching&amp;nbsp;first&amp;nbsp;result&amp;nbsp;set\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'\nFetching&amp;nbsp;second&amp;nbsp;result&amp;nbsp;set\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'\nFetching&amp;nbsp;third&amp;nbsp;result&amp;nbsp;set\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_next_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$res2</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res2</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Fetching first result set array(2) { [0]=&amp;gt; string(16) &amp;quot;Bubbles &amp;quot; [1]=&amp;gt; int(3) } array(2) { [0]=&amp;gt; string(16) &amp;quot;Gizmo &amp;quot; [1]=&amp;gt; int(4) } Fetching second result set array(4) { [0]=&amp;gt; string(16) &amp;quot;Sweater &amp;quot; [1]=&amp;gt; int(6) [2]=&amp;gt; string(5) &amp;quot;llama&amp;quot; [3]=&amp;gt; string(6) &amp;quot;150.00&amp;quot; } array(4) { [0]=&amp;gt; string(16) &amp;quot;Smarty &amp;quot; [1]=&amp;gt; int(2) [2]=&amp;gt; string(5) &amp;quot;horse&amp;quot; [3]=&amp;gt; string(6) &amp;quot;350.00&amp;quot; } Fetching third result set array(1) { [0]=&amp;gt; string(16) &amp;quot;Bubbles &amp;quot; } array(1) { [0]=&amp;gt; string(16) &amp;quot;Gizmo &amp;quot; } </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_lob_read" value="<div id='function.db2-lob-read' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-lob-read.php'>db2_lob_read</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.6.0)</p><p class='refpurpose'><span class='refname'>db2_lob_read</span> &amp;mdash; <span class='dc-title'> Gets a user defined size of LOB files with each invocation </span></p> </div> <a name='function.db2-lob-read.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_lob_read</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$colnum</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$length</tt></span> )</div> <p class='para rdfs-comment'> Use <b>db2_lob_read()</b> to iterate through a specified column of a result set and retrieve a user defined size of LOB data. </p> </div> <a name='function.db2-lob-read.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing LOB data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>colnum</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid column number in the result set of the <i>stmt</i> resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>length</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The size of the LOB data to be retrieved from the <i>stmt</i> resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-lob-read.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the amount of data the user specifies. Returns <b><tt class='constant'>FALSE</tt></b> if the data cannot be retrieved. </p> </div> <a name='function.db2-lob-read.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Iterating through different types of data</b></p> <div class='example-contents para'><p> </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$db&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$username&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$db</span><span style='color: #007700'>,</span><span style='color: #0000BB'>$username</span><span style='color: #007700'>,</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$drop&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;clob_stream'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$drop&amp;nbsp;</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;clob_stream&amp;nbsp;(id&amp;nbsp;INTEGER,&amp;nbsp;my_clob&amp;nbsp;CLOB)'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$variable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;clob_stream&amp;nbsp;(id,my_clob)&amp;nbsp;VALUES&amp;nbsp;(1,&amp;nbsp;?)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$variable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'THIS&amp;nbsp;IS&amp;nbsp;A&amp;nbsp;CLOB&amp;nbsp;TEST.&amp;nbsp;THIS&amp;nbsp;IS&amp;nbsp;A&amp;nbsp;CLOB&amp;nbsp;TEST.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,my_clob&amp;nbsp;FROM&amp;nbsp;clob_stream'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Read&amp;nbsp;LOB&amp;nbsp;data&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_lob_read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Loop&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #DD0000'>:&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$drop&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DROP&amp;nbsp;TABLE&amp;nbsp;blob_stream'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$drop&amp;nbsp;</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;blob_stream&amp;nbsp;(id&amp;nbsp;INTEGER,&amp;nbsp;my_blob&amp;nbsp;CLOB)'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$variable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;blob_stream&amp;nbsp;(id,my_blob)&amp;nbsp;VALUES&amp;nbsp;(1,&amp;nbsp;?)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$variable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'THIS&amp;nbsp;IS&amp;nbsp;A&amp;nbsp;BLOB&amp;nbsp;TEST.&amp;nbsp;THIS&amp;nbsp;IS&amp;nbsp;A&amp;nbsp;BLOB&amp;nbsp;TEST.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'variable'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,my_blob&amp;nbsp;FROM&amp;nbsp;blob_stream'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Read&amp;nbsp;LOB&amp;nbsp;data&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>while&amp;nbsp;(</span><span style='color: #0000BB'>$data&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_lob_read</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>6</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Loop&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #DD0000'>:&amp;nbsp;</span><span style='color: #0000BB'>$data</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'no&amp;nbsp;connection:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>db2_conn_errormsg</span><span style='color: #007700'>();<br />}<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Loop 0: THIS I Loop 1: S A CL Loop 2: OB TES Loop 3: T. THI Loop 4: S IS A Loop 5: CLOB Loop 6: TEST. Loop 0: THIS I Loop 1: S A BL Loop 2: OB TES Loop 3: T. THI Loop 4: S IS A Loop 5: BLOB Loop 6: TEST. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-lob-read.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-bind-param.php' class='function' rel='rdfs-seeAlso'>db2_bind_param()</a> - Binds a PHP variable to an SQL statement parameter</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-exec.php' class='function' rel='rdfs-seeAlso'>db2_exec()</a> - Executes an SQL statement directly</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-execute.php' class='function' rel='rdfs-seeAlso'>db2_execute()</a> - Executes a prepared SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_last_insert_id" value="<div id='function.db2-last-insert-id' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-last-insert-id.php'>db2_last_insert_id</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.7.1)</p><p class='refpurpose'><span class='refname'>db2_last_insert_id</span> &amp;mdash; <span class='dc-title'>Returns the auto generated ID of the last insert query that successfully executed on this connection</span></p> </div> <a name='function.db2-last-insert-id.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>db2_last_insert_id</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$resource</tt></span> )</div> <p class='para rdfs-comment'> Returns the auto generated ID of the last insert query that successfully executed on this connection. </p> <p class='para'> The result of this function is not affected by any of the following: </p><ul class='itemizedlist'> <li class='listitem'> <p class='para'> A single row INSERT statement with a VALUES clause for a table without an identity column. </p> </li> <li class='listitem'> <p class='para'> A multiple row INSERT statement with a VALUES clause. </p> </li> <li class='listitem'> <p class='para'> An INSERT statement with a fullselect. </p> </li> <li class='listitem'> <p class='para'> A ROLLBACK TO SAVEPOINT statement. </p> </li> </ul><p> </p> </div> <a name='function.db2-last-insert-id.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'>resource</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection resource as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. The value of this parameter cannot be a statement resource or result set resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-last-insert-id.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the auto generated ID of last insert query that successfully executed on this connection. </p> </div> <a name='function.db2-last-insert-id.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_last_insert_id()</b> example</b></p> <div class='example-contents para'><p> The following example shows how to return the auto generated ID of last insert query that successfully executed on this connection. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br />if(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$createTable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;lastInsertID&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;(id&amp;nbsp;integer&amp;nbsp;GENERATED&amp;nbsp;BY&amp;nbsp;DEFAULT&amp;nbsp;AS&amp;nbsp;IDENTITY,&amp;nbsp;name&amp;nbsp;varchar(20))'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$insertTable&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;lastInsertID&amp;nbsp;(name)&amp;nbsp;VALUES&amp;nbsp;('Temp&amp;nbsp;Name')'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;@</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$createTable</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>/*&amp;nbsp;Checking&amp;nbsp;for&amp;nbsp;single&amp;nbsp;row&amp;nbsp;inserted.&amp;nbsp;*/<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$insertTable</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_last_insert_id</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>$ret</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Last&amp;nbsp;Insert&amp;nbsp;ID&amp;nbsp;is&amp;nbsp;:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>$ret&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'No&amp;nbsp;Last&amp;nbsp;insert&amp;nbsp;ID.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Last Insert ID is : 1 </pre></div> </div> </div><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_get_option" value="<div id='function.db2-get-option' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-get-option.php'>db2_get_option</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.6.0)</p><p class='refpurpose'><span class='refname'>db2_get_option</span> &amp;mdash; <span class='dc-title'>Retrieves an option value for a statement resource or a connection resource</span></p> </div> <a name='function.db2-get-option.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_get_option</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$resource</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$option</tt></span> )</div> <p class='para rdfs-comment'> Retrieves the value of a specified option value for a statement resource or a connection resource. </p> </div> <a name='function.db2-get-option.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'>resource</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource as returned from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> or a valid connection resource as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>option</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement or connection options. The following new options are available as of ibm_db2 version 1.6.0. They provide useful tracking information that can be set during execution with <b>db2_get_option()</b>. </p><blockquote><p><b class='note'>Note</b>: <b>Note</b><br /> Prior versions of ibm_db2 do not support these new options. <br /> When the value in each option is being set, some servers might not handle the entire length provided and might truncate the value. <br /> To ensure that the data specified in each option is converted correctly when transmitted to a host system, use only the characters A through Z, 0 through 9, and the underscore (_) or period (.). <br /> </p></blockquote><p> </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>userid</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_USERID</i> - A pointer to a null-terminated character string used to identify the client user ID sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: <b>Note</b><br /> DB2 for z/OS and OS/390 servers support up to a length of 16 characters. This user-id is not to be confused with the authentication user-id, it is for identification purposes only and is not used for any authorization. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>acctstr</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_ACCTSTR</i> - A pointer to a null-terminated character string used to identify the client accounting string sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: <b>Note</b><br /> DB2 for z/OS and OS/390 servers support up to a length of 200 characters. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>applname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_APPLNAME</i> - A pointer to a null-terminated character string used to identify the client application name sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: <b>Note</b><br /> DB2 for z/OS and OS/390 servers support up to a length of 32 characters. <br /> </p></blockquote><p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>wrkstnname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>SQL_ATTR_INFO_WRKSTNNAME</i> - A pointer to a null-terminated character string used to identify the client workstation name sent to the host database server when using DB2 Connect. </p><blockquote><p><b class='note'>Note</b>: <b>Note</b><br /> DB2 for z/OS and OS/390 servers support up to a length of 18 characters. <br /> </p></blockquote><p> </p> </dd> </dl> <p> </p> </dd> </dl> <p> </p> <p class='para'> The following table specifies which options are compatible with the available resource types: </p><table class='doctable table'> <caption><b>Resource-Parameter Matrix</b></caption> <col align='center' /> <col align='center' /> <col align='center' /> <col align='center' /> <col align='center' /> <thead valign='middle'> <tr valign='middle'> <th>Key</th> <th>Value</th> <th colspan='3'>Resource Type</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td class='empty'>&amp;nbsp;</td><td class='empty'>&amp;nbsp;</td><td align='center'>Connection</td> <td align='center'>Statement</td> <td align='center'>Result Set</td> </tr> <tr valign='middle'> <td align='left'>userid</td> <td align='left'><i>SQL_ATTR_INFO_USERID</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>acctstr</td> <td align='left'><i>SQL_ATTR_INFO_ACCTSTR</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>applname</td> <td align='left'><i>SQL_ATTR_INFO_APPLNAME</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> <tr valign='middle'> <td align='left'>wrkstnname</td> <td align='left'><i>SQL_ATTR_INFO_WRKSTNNAME</i></td> <td align='center'>X</td> <td align='center'>X</td> <td align='center'>-</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-get-option.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the current setting of the connection attribute provided on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-get-option.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Setting and retrieving parameters through a connection resource</b></p> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /></span><span style='color: #FF8000'>/*&amp;nbsp;Database&amp;nbsp;Connection&amp;nbsp;Parameters&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Obtain&amp;nbsp;Connection&amp;nbsp;Resource&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Client&amp;nbsp;attributes&amp;nbsp;passed&amp;nbsp;through&amp;nbsp;connection&amp;nbsp;string:\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br />/*&amp;nbsp;Assign&amp;nbsp;the&amp;nbsp;attributes&amp;nbsp;through&amp;nbsp;connection&amp;nbsp;string&amp;nbsp;*/<br />/*&amp;nbsp;Access&amp;nbsp;the&amp;nbsp;options&amp;nbsp;specified&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'userid'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn1&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'userid'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'acctstr'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'account'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn2&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options2</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'acctstr'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'applname'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'myapp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn3&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options3</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'applname'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'wrkstnname'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'workstation'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn4&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options4</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'wrkstnname'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br />echo&amp;nbsp;</span><span style='color: #DD0000'>'Client&amp;nbsp;attributes&amp;nbsp;passed&amp;nbsp;post-connection:\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #FF8000'>/*&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;associative&amp;nbsp;options&amp;nbsp;array&amp;nbsp;with&amp;nbsp;valid&amp;nbsp;key-value&amp;nbsp;pairs&amp;nbsp;*/<br />/*&amp;nbsp;Assign&amp;nbsp;the&amp;nbsp;attributes&amp;nbsp;after&amp;nbsp;a&amp;nbsp;connection&amp;nbsp;is&amp;nbsp;made&amp;nbsp;*/<br />/*&amp;nbsp;Access&amp;nbsp;the&amp;nbsp;options&amp;nbsp;specified&amp;nbsp;*/<br /></span><span style='color: #0000BB'>$options5&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'userid'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn5&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'userid'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options6&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'acctstr'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'account'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn6&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'acctstr'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options7&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'applname'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'myapp'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn7&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn7</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options7</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn7</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'applname'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$options8&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'wrkstnname'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #DD0000'>'workstation'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn8&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn8</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'wrkstnname'</span><span style='color: #007700'>);<br />echo&amp;nbsp;</span><span style='color: #0000BB'>$val&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Client attributes passed through connection string: db2inst1 account myapp workstation Client attributes passed post-connection: db2inst1 account myapp workstation</pre></div> </div> </div><p> </p> </div> <a name='function.db2-get-option.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-cursor-type.php' class='function' rel='rdfs-seeAlso'>db2_cursor_type()</a> - Returns the cursor type used by a statement resource</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-exec.php' class='function' rel='rdfs-seeAlso'>db2_exec()</a> - Executes an SQL statement directly</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-set-option.php' class='function' rel='rdfs-seeAlso'>db2_set_option()</a> - Set options for connection or statement resources</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_free_stmt" value="<div id='function.db2-free-stmt' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-free-stmt.php'>db2_free_stmt</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_free_stmt</span> &amp;mdash; <span class='dc-title'> Frees resources associated with the indicated statement resource </span></p> </div> <a name='function.db2-free-stmt.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_free_stmt</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Frees the system and database resources that are associated with a statement resource. These resources are freed implicitly when a script finishes, but you can call <b>db2_free_stmt()</b> to explicitly free the statement resources before the end of the script. </p> </div> <a name='function.db2-free-stmt.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-free-stmt.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-free-stmt.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-free-result.php' class='function' rel='rdfs-seeAlso'>db2_free_result()</a> - Frees resources associated with a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_free_result" value="<div id='function.db2-free-result' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-free-result.php'>db2_free_result</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_free_result</span> &amp;mdash; <span class='dc-title'> Frees resources associated with a result set </span></p> </div> <a name='function.db2-free-result.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_free_result</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Frees the system and database resources that are associated with a result set. These resources are freed implicitly when a script finishes, but you can call <b>db2_free_result()</b> to explicitly free the result set resources before the end of the script. </p> </div> <a name='function.db2-free-result.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-free-result.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-free-result.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-free-stmt.php' class='function' rel='rdfs-seeAlso'>db2_free_stmt()</a> - Frees resources associated with the indicated statement resource</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_foreign_keys" value="<div id='function.db2-foreign-keys' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-foreign-keys.php'>db2_foreign_keys</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_foreign_keys</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the foreign keys for a table </span></p> </div> <a name='function.db2-foreign-keys.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_foreign_keys</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> )</div> <p class='para rdfs-comment'> Returns a result set listing the foreign keys for a table. </p> </div> <a name='function.db2-foreign-keys.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. If <i><tt class='parameter'>schema</tt></i> is <b><tt class='constant'>NULL</tt></b>, <b>db2_foreign_keys()</b> matches the schema for the current connection. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-foreign-keys.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the foreign keys for the specified table. The result set is composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>PKTABLE_CAT</td> <td align='left'> Name of the catalog for the table containing the primary key. The value is NULL if this table does not have catalogs. </td> </tr> <tr valign='middle'> <td align='left'>PKTABLE_SCHEM</td> <td align='left'> Name of the schema for the table containing the primary key. </td> </tr> <tr valign='middle'> <td align='left'>PKTABLE_NAME</td> <td align='left'>Name of the table containing the primary key.</td> </tr> <tr valign='middle'> <td align='left'>PKCOLUMN_NAME</td> <td align='left'>Name of the column containing the primary key.</td> </tr> <tr valign='middle'> <td align='left'>FKTABLE_CAT</td> <td align='left'> Name of the catalog for the table containing the foreign key. The value is NULL if this table does not have catalogs. </td> </tr> <tr valign='middle'> <td align='left'>FKTABLE_SCHEM</td> <td align='left'> Name of the schema for the table containing the foreign key. </td> </tr> <tr valign='middle'> <td align='left'>FKTABLE_NAME</td> <td align='left'>Name of the table containing the foreign key.</td> </tr> <tr valign='middle'> <td align='left'>FKCOLUMN_NAME</td> <td align='left'>Name of the column containing the foreign key.</td> </tr> <tr valign='middle'> <td align='left'>KEY_SEQ</td> <td align='left'>1-indexed position of the column in the key.</td> </tr> <tr valign='middle'> <td align='left'>UPDATE_RULE</td> <td align='left'> Integer value representing the action applied to the foreign key when the SQL operation is UPDATE. </td> </tr> <tr valign='middle'> <td align='left'>DELETE_RULE</td> <td align='left'> Integer value representing the action applied to the foreign key when the SQL operation is DELETE. </td> </tr> <tr valign='middle'> <td align='left'>FK_NAME</td> <td align='left'>The name of the foreign key.</td> </tr> <tr valign='middle'> <td align='left'>PK_NAME</td> <td align='left'>The name of the primary key.</td> </tr> <tr valign='middle'> <td align='left'>DEFERRABILITY</td> <td align='left'> An integer value representing whether the foreign key deferrability is SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE, or SQL_NOT_DEFERRABLE. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-foreign-keys.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_width" value="<div id='function.db2-field-width' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-width.php'>db2_field_width</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_width</span> &amp;mdash; <span class='dc-title'> Returns the width of the current value of the indicated column in a result set </span></p> </div> <a name='function.db2-field-width.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>db2_field_width</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the width of the current value of the indicated column in a result set. This is the maximum width of the column for a fixed-length data type, or the actual width of the column for a variable-length data type. </p> </div> <a name='function.db2-field-width.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-width.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer containing the width of the specified character or binary data type column in a result set. If the specified column does not exist in the result set, <b>db2_field_width()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-width.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_type" value="<div id='function.db2-field-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-type.php'>db2_field_type</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_type</span> &amp;mdash; <span class='dc-title'> Returns the data type of the indicated column in a result set </span></p> </div> <a name='function.db2-field-type.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_field_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the data type of the indicated column in a result set. </p> </div> <a name='function.db2-field-type.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the defined data type of the specified column. If the specified column does not exist in the result set, <b>db2_field_type()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_scale" value="<div id='function.db2-field-scale' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-scale.php'>db2_field_scale</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_scale</span> &amp;mdash; <span class='dc-title'> Returns the scale of the indicated column in a result set </span></p> </div> <a name='function.db2-field-scale.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>db2_field_scale</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the scale of the indicated column in a result set. </p> </div> <a name='function.db2-field-scale.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-scale.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer containing the scale of the specified column. If the specified column does not exist in the result set, <b>db2_field_scale()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-scale.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_precision" value="<div id='function.db2-field-precision' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-precision.php'>db2_field_precision</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_precision</span> &amp;mdash; <span class='dc-title'> Returns the precision of the indicated column in a result set </span></p> </div> <a name='function.db2-field-precision.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>db2_field_precision</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the precision of the indicated column in a result set. </p> </div> <a name='function.db2-field-precision.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-precision.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer containing the precision of the specified column. If the specified column does not exist in the result set, <b>db2_field_precision()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-precision.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_num" value="<div id='function.db2-field-num' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-num.php'>db2_field_num</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_num</span> &amp;mdash; <span class='dc-title'> Returns the position of the named column in a result set </span></p> </div> <a name='function.db2-field-num.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>db2_field_num</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the position of the named column in a result set. </p> </div> <a name='function.db2-field-num.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-num.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer containing the 0-indexed position of the named column in the result set. If the specified column does not exist in the result set, <b>db2_field_num()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-num.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_name" value="<div id='function.db2-field-name' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-name.php'>db2_field_name</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_name</span> &amp;mdash; <span class='dc-title'> Returns the name of the column in the result set </span></p> </div> <a name='function.db2-field-name.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_field_name</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the name of the specified column in the result set. </p> </div> <a name='function.db2-field-name.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-name.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the name of the specified column. If the specified column does not exist in the result set, <b>db2_field_name()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-name.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-display-size.php' class='function' rel='rdfs-seeAlso'>db2_field_display_size()</a> - Returns the maximum number of bytes required to display a column</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_field_display_size" value="<div id='function.db2-field-display-size' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-field-display-size.php'>db2_field_display_size</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_field_display_size</span> &amp;mdash; <span class='dc-title'> Returns the maximum number of bytes required to display a column </span></p> </div> <a name='function.db2-field-display-size.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>db2_field_display_size</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <tt class='parameter'>$column</tt></span> )</div> <p class='para rdfs-comment'> Returns the maximum number of bytes required to display a column in a result set. </p> </div> <a name='function.db2-field-display-size.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies a statement resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the column in the result set. This can either be an integer representing the 0-indexed position of the column, or a string containing the name of the column. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-field-display-size.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an integer value with the maximum number of bytes required to display the specified column. If the column does not exist in the result set, <b>db2_field_display_size()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-field-display-size.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-name.php' class='function' rel='rdfs-seeAlso'>db2_field_name()</a> - Returns the name of the column in the result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-num.php' class='function' rel='rdfs-seeAlso'>db2_field_num()</a> - Returns the position of the named column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-precision.php' class='function' rel='rdfs-seeAlso'>db2_field_precision()</a> - Returns the precision of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-scale.php' class='function' rel='rdfs-seeAlso'>db2_field_scale()</a> - Returns the scale of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-type.php' class='function' rel='rdfs-seeAlso'>db2_field_type()</a> - Returns the data type of the indicated column in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-field-width.php' class='function' rel='rdfs-seeAlso'>db2_field_width()</a> - Returns the width of the current value of the indicated column in a result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_fetch_row" value="<div id='function.db2-fetch-row' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-fetch-row.php'>db2_fetch_row</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_fetch_row</span> &amp;mdash; <span class='dc-title'> Sets the result set pointer to the next row or requested row </span></p> </div> <a name='function.db2-fetch-row.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_fetch_row</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt></span> ] )</div> <p class='para rdfs-comment'> Use <b>db2_fetch_row()</b> to iterate through a result set, or to point to a specific row in a result set if you requested a scrollable cursor. </p> <p class='para'> To retrieve individual fields from the result set, call the <a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a> function. </p> <p class='para'> Rather than calling <b>db2_fetch_row()</b> and <a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a>, most applications will call one of <a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function'>db2_fetch_assoc()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function'>db2_fetch_both()</a>, or <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a> to advance the result set pointer and return a complete row as an array. </p> </div> <a name='function.db2-fetch-row.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> With scrollable cursors, you can request a specific row number in the result set. Row numbering is 1-indexed. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-fetch-row.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> if the requested row exists in the result set. Returns <b><tt class='constant'>FALSE</tt></b> if the requested row does not exist in the result set. </p> </div> <a name='function.db2-fetch-row.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Iterating through a result set</b></p> <div class='example-contents para'><p> The following example demonstrates how to iterate through a result set with <b>db2_fetch_row()</b> and retrieve columns from the result set with <a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;name,&amp;nbsp;breed&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;WHERE&amp;nbsp;weight&amp;nbsp;&amp;lt;&amp;nbsp;?'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>10</span><span style='color: #007700'>));<br />while&amp;nbsp;(</span><span style='color: #0000BB'>db2_fetch_row</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$breed&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_result</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$name</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #0000BB'>$breed</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> cat Pook gold fish Bubbles budgerigar Gizmo goat Rickety Ride </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 i5/OS recommended alternatives to db2_fetch_row/db2_result</b></p> <div class='example-contents para'><p> On i5/OS it is recommended that you use <a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function'>db2_fetch_both()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a>, or <a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function'>db2_fetch_object()</a> over <b>db2_fetch_row()</b>/<a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a>. In general <b>db2_fetch_row()</b>/<a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a> have more issues with various column types in <i>EBCIDIC</i> to <i>ASCII</i> translation, including possible truncation in <i>DBCS</i> applications. You may also find the performance of <a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function'>db2_fetch_both()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a>, and <a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function'>db2_fetch_object()</a> to be superior to <b>db2_fetch_row()</b>/<a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;SPECIFIC_SCHEMA,&amp;nbsp;SPECIFIC_NAME,&amp;nbsp;ROUTINE_SCHEMA,&amp;nbsp;ROUTINE_NAME,&amp;nbsp;ROUTINE_TYPE,&amp;nbsp;ROUTINE_CREATED,&amp;nbsp;ROUTINE_BODY,&amp;nbsp;IN_PARMS,&amp;nbsp;OUT_PARMS,&amp;nbsp;INOUT_PARMS,&amp;nbsp;PARAMETER_STYLE,&amp;nbsp;EXTERNAL_NAME,&amp;nbsp;EXTERNAL_LANGUAGE&amp;nbsp;FROM&amp;nbsp;QSYS2.SYSROUTINES&amp;nbsp;FETCH&amp;nbsp;FIRST&amp;nbsp;2&amp;nbsp;ROWS&amp;nbsp;ONLY'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_both</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;db2_fetch_both&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'SPECIFIC_NAME'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ROUTINE_CREATED'</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;db2_fetch_array&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'&amp;lt;br&amp;gt;db2_fetch_object&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>SPECIFIC_NAME</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ROUTINE_CREATED</span><span style='color: #007700'>}</span><span style='color: #DD0000'>'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> db2_fetch_both MATCH_ANIMAL 2006-08-25-17.10.23.775000 2006-08-25-17.10.23.775000 db2_fetch_both MULTIRESULTS 2006-10-17-10.11.05.308000 2006-10-17-10.11.05.308000 db2_fetch_array MATCH_ANIMAL 2006-08-25-17.10.23.775000 db2_fetch_array MULTIRESULTS 2006-10-17-10.11.05.308000 db2_fetch_object MATCH_ANIMAL 2006-08-25-17.10.23.775000 db2_fetch_object MULTIRESULTS 2006-10-17-10.11.05.308000 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-fetch-row.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function' rel='rdfs-seeAlso'>db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_fetch_object" value="<div id='function.db2-fetch-object' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-fetch-object.php'>db2_fetch_object</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_fetch_object</span> &amp;mdash; <span class='dc-title'> Returns an object with properties representing columns in the fetched row </span></p> </div> <a name='function.db2-fetch-object.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>db2_fetch_object</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> Returns an object in which each property represents a column returned in the row fetched from a result set. </p> </div> <a name='function.db2-fetch-object.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Requests a specific 1-indexed row from the result set. Passing this parameter results in a PHP warning if the result set uses a forward-only cursor. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-fetch-object.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object representing a single row in the result set. The properties of the object map to the names of the columns in the result set. </p> <p class='para'> The IBM DB2, Cloudscape, and Apache Derby database servers typically fold column names to upper-case, so the object properties will reflect that case. </p> <p class='para'> If your SELECT statement calls a scalar function to modify the value of a column, the database servers return the column number as the name of the column in the result set. If you prefer a more descriptive column name and object property, you can use the AS clause to assign a name to the column in the result set. </p> <p class='para'> Returns <b><tt class='constant'>FALSE</tt></b> if no row was retrieved. </p> </div> <a name='function.db2-fetch-object.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_fetch_object()</b> example</b></p> <div class='example-contents para'><p> The following example issues a SELECT statement with a scalar function, RTRIM, that removes whitespace from the end of the column. Rather than creating an object with the properties &amp;quot;BREED&amp;quot; and &amp;quot;2&amp;quot;, we use the AS clause in the SELECT statement to assign the name &amp;quot;name&amp;quot; to the modified column. The database server folds the column names to upper-case, resulting in an object with the properties &amp;quot;BREED&amp;quot; and &amp;quot;NAME&amp;quot;. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;breed,&amp;nbsp;RTRIM(name)&amp;nbsp;AS&amp;nbsp;name<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FROM&amp;nbsp;animals<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;id&amp;nbsp;=&amp;nbsp;?'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>));<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$pet&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Come&amp;nbsp;here,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$pet</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NAME</span><span style='color: #007700'>}</span><span style='color: #DD0000'>,&amp;nbsp;my&amp;nbsp;little&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$pet</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>BREED</span><span style='color: #007700'>}</span><span style='color: #DD0000'>!'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Come here, Pook, my little cat! </pre></div> </div> </div><p> </p> </div> <a name='function.db2-fetch-object.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_fetch_both" value="<div id='function.db2-fetch-both' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-fetch-both.php'>db2_fetch_both</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_fetch_both</span> &amp;mdash; <span class='dc-title'> Returns an array, indexed by both column name and position, representing a row in a result set </span></p> </div> <a name='function.db2-fetch-both.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>db2_fetch_both</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> Returns an array, indexed by both column name and position, representing a row in a result set. Note that the row returned by <b>db2_fetch_both()</b> requires more memory than the single-indexed arrays returned by <a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function'>db2_fetch_assoc()</a> or <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a>. </p> </div> <a name='function.db2-fetch-both.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Requests a specific 1-indexed row from the result set. Passing this parameter results in a PHP warning if the result set uses a forward-only cursor. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-fetch-both.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array with column values indexed by both the column name and 0-indexed column number. The array represents the next or requested row in the result set. Returns <b><tt class='constant'>FALSE</tt></b> if there are no rows left in the result set, or if the row requested by <i><tt class='parameter'>row_number</tt></i> does not exist in the result set. </p> </div> <a name='function.db2-fetch-both.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Iterating through a forward-only cursor</b></p> <div class='example-contents para'><p> If you call <b>db2_fetch_both()</b> without a specific row number, it automatically retrieves the next row in the result set. The following example accesses columns in the returned array by both column name and by numeric index. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_both</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ID'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'BREED'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Retrieving specific rows with <b>db2_fetch_both()</b> from a scrollable cursor</b></p> <div class='example-contents para'><p> If your result set uses a scrollable cursor, you can call <b>db2_fetch_both()</b> with a specific row number. The following example retrieves every other row in the result set, starting with the second row. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_both</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NAME'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'WEIGHT'</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-fetch-both.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function' rel='rdfs-seeAlso'>db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_fetch_assoc" value="<div id='function.db2-fetch-assoc' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-fetch-assoc.php'>db2_fetch_assoc</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_fetch_assoc</span> &amp;mdash; <span class='dc-title'> Returns an array, indexed by column name, representing a row in a result set </span></p> </div> <a name='function.db2-fetch-assoc.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>db2_fetch_assoc</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> Returns an array, indexed by column name, representing a row in a result set. </p> </div> <a name='function.db2-fetch-assoc.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Requests a specific 1-indexed row from the result set. Passing this parameter results in a PHP warning if the result set uses a forward-only cursor. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-fetch-assoc.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an associative array with column values indexed by the column name representing the next or requested row in the result set. Returns <b><tt class='constant'>FALSE</tt></b> if there are no rows left in the result set, or if the row requested by <i><tt class='parameter'>row_number</tt></i> does not exist in the result set. </p> </div> <a name='function.db2-fetch-assoc.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Iterating through a forward-only cursor</b></p> <div class='example-contents para'><p> If you call <b>db2_fetch_assoc()</b> without a specific row number, it automatically retrieves the next row in the result set. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ID'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NAME'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'BREED'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'WEIGHT'</span><span style='color: #007700'>]);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Retrieving specific rows with <b>db2_fetch_assoc()</b> from a scrollable cursor</b></p> <div class='example-contents para'><p> If your result set uses a scrollable cursor, you can call <b>db2_fetch_assoc()</b> with a specific row number. The following example retrieves every other row in the result set, starting with the second row. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_assoc</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'ID'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'NAME'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'BREED'</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'WEIGHT'</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-fetch-assoc.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function' rel='rdfs-seeAlso'>db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_fetch_array" value="<div id='function.db2-fetch-array' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-fetch-array.php'>db2_fetch_array</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.1)</p><p class='refpurpose'><span class='refname'>db2_fetch_array</span> &amp;mdash; <span class='dc-title'> Returns an array, indexed by column position, representing a row in a result set </span></p> </div> <a name='function.db2-fetch-array.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>array</span> <span class='methodname'><b>db2_fetch_array</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$row_number</tt><span class='initializer'> = -1</span></span> ] )</div> <p class='para rdfs-comment'> Returns an array, indexed by column position, representing a row in a result set. The columns are 0-indexed. </p> </div> <a name='function.db2-fetch-array.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid <i>stmt</i> resource containing a result set. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>row_number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Requests a specific 1-indexed row from the result set. Passing this parameter results in a PHP warning if the result set uses a forward-only cursor. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-fetch-array.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a 0-indexed array with column values indexed by the column position representing the next or requested row in the result set. Returns <b><tt class='constant'>FALSE</tt></b> if there are no rows left in the result set, or if the row requested by <i><tt class='parameter'>row_number</tt></i> does not exist in the result set. </p> </div> <a name='function.db2-fetch-array.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Iterating through a forward-only cursor</b></p> <div class='example-contents para'><p> If you call <b>db2_fetch_array()</b> without a specific row number, it automatically retrieves the next row in the result set. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]);<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Retrieving specific rows with <b>db2_fetch_array()</b> from a scrollable cursor</b></p> <div class='example-contents para'><p> If your result set uses a scrollable cursor, you can call <b>db2_fetch_array()</b> with a specific row number. The following example retrieves every other row in the result set, starting with the second row. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;id,&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;breed'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br /><br /></span><span style='color: #0000BB'>$i</span><span style='color: #007700'>=</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$i</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'%-5d&amp;nbsp;%-16s&amp;nbsp;%-32s&amp;nbsp;%10s\n'</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>],&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>$i&amp;nbsp;</span><span style='color: #007700'>+&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 Pook cat 3.20 5 Rickety Ride goat 9.70 2 Smarty horse 350.00 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-fetch-array.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-object.php' class='function' rel='rdfs-seeAlso'>db2_fetch_object()</a> - Returns an object with properties representing columns in the fetched row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_execute" value="<div id='function.db2-execute' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-execute.php'>db2_execute</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_execute</span> &amp;mdash; <span class='dc-title'> Executes a prepared SQL statement </span></p> </div> <a name='function.db2-execute.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_execute</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$parameters</tt></span> ] )</div> <p class='para rdfs-comment'> <b>db2_execute()</b> executes an SQL statement that was prepared by <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a>. </p> <p class='para'> If the SQL statement returns a result set, for example, a SELECT statement or a CALL to a stored procedure that returns one or more result sets, you can retrieve a row as an array from the <i>stmt</i> resource using <a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function'>db2_fetch_assoc()</a>, <a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function'>db2_fetch_both()</a>, or <a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function'>db2_fetch_array()</a>. Alternatively, you can use <a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function'>db2_fetch_row()</a> to move the result set pointer to the next row and fetch a column at a time from that row with <a href='http://www.php.net/manual/en/function.db2-result.php' class='function'>db2_result()</a>. </p> <p class='para'> Refer to <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> for a brief discussion of the advantages of using <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> and <b>db2_execute()</b> rather than <a href='http://www.php.net/manual/en/function.db2-exec.php' class='function'>db2_exec()</a>. </p> </div> <a name='function.db2-execute.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A prepared statement returned from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>parameters</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An array of input parameters matching any parameter markers contained in the prepared statement. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-execute.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-execute.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Preparing and executing an SQL statement with parameter markers</b></p> <div class='example-contents para'><p> The following example prepares an INSERT statement that accepts four parameter markers, then iterates over an array of arrays containing the input values to be passed to <b>db2_execute()</b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$pet&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cat'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Pook'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3.2</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$insert&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;animals&amp;nbsp;(id,&amp;nbsp;breed,&amp;nbsp;name,&amp;nbsp;weight)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;VALUES&amp;nbsp;(?,&amp;nbsp;?,&amp;nbsp;?,&amp;nbsp;?)'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$insert</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$pet</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;added&amp;nbsp;new&amp;nbsp;pet.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Successfully added new pet. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Calling a stored procedure with an OUT parameter</b></p> <div class='example-contents para'><p> The following example prepares a CALL statement that accepts one parameter marker representing an OUT parameter, binds the PHP variable <i>$my_pets</i> to the parameter using <a href='http://www.php.net/manual/en/function.db2-bind-param.php' class='function'>db2_bind_param()</a>, then issues <b>db2_execute()</b> to execute the CALL statement. After the CALL to the stored procedure has been made, the value of <i>$num_pets</i> changes to reflect the value returned by the stored procedure for that OUT parameter. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$num_pets&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'CALL&amp;nbsp;count_my_pets(?)'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'num_pets'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_OUT</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$res</span><span style='color: #007700'>);<br />print&amp;nbsp;</span><span style='color: #DD0000'>'I&amp;nbsp;have&amp;nbsp;</span><span style='color: #0000BB'>$num_pets</span><span style='color: #DD0000'>&amp;nbsp;pets!'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> I have 7 pets! </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 Returning XML data as a SQL ResultSet</b></p> <div class='example-contents para'><p> The following example demonstrates how to work with documents stored in a XML column using the SAMPLE database. Using some pretty simple SQL/XML, this example returns some of the nodes in a XML document in a SQL ResultSet format that most users are familiar with. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;XMLTABLE(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;\'db2-fn:xmlcolumn('CUSTOMER.INFO')/customerinfo\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;COLUMNS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'CID'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'@Cid\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'NAME'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'name\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'PHONE'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'phone&amp;nbsp;[&amp;nbsp;@type&amp;nbsp;=&amp;nbsp;'work']\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)&amp;nbsp;AS&amp;nbsp;T<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;NAME&amp;nbsp;=&amp;nbsp;?<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Kathy&amp;nbsp;Smith'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CID</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NAME</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PHONE</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1000 Kathy Smith 416-555-1358 1001 Kathy Smith 905-555-7258 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #4 Performing a &amp;quot;JOIN&amp;quot; with XML data</b></p> <div class='example-contents para'><p> The following example works with documents stored in 2 different XML columns in the SAMPLE database. It creates 2 temporary tables from the XML documents from 2 different columns and returns a SQL ResultSet with information regarding shipping status for the customer. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />SELECT&amp;nbsp;A.CID,&amp;nbsp;A.NAME,&amp;nbsp;A.PHONE,&amp;nbsp;C.PONUM,&amp;nbsp;C.STATUS<br />FROM<br />XMLTABLE(<br />XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />\'db2-fn:xmlcolumn('CUSTOMER.INFO')/customerinfo\'<br />COLUMNS<br />'CID'&amp;nbsp;BIGINT&amp;nbsp;PATH&amp;nbsp;\'@Cid\',<br />'NAME'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'name\',<br />'PHONE'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'phone&amp;nbsp;[&amp;nbsp;@type&amp;nbsp;=&amp;nbsp;'work']\'<br />)&amp;nbsp;as&amp;nbsp;A,<br />PURCHASEORDER&amp;nbsp;AS&amp;nbsp;B,<br />XMLTABLE&amp;nbsp;(<br />XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />\'db2-fn:xmlcolumn('PURCHASEORDER.PORDER')/PurchaseOrder\'<br />COLUMNS<br />'PONUM'&amp;nbsp;&amp;nbsp;BIGINT&amp;nbsp;PATH&amp;nbsp;\'@PoNum\',<br />'STATUS'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'@Status\'<br />)&amp;nbsp;as&amp;nbsp;C<br />WHERE&amp;nbsp;A.CID&amp;nbsp;=&amp;nbsp;B.CUSTID&amp;nbsp;AND<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;B.POID&amp;nbsp;=&amp;nbsp;C.PONUM&amp;nbsp;AND<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;A.NAME&amp;nbsp;=&amp;nbsp;?<br />'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Kathy&amp;nbsp;Smith'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CID</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NAME</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PHONE</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PONUM</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>STATUS</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1001 Kathy Smith 905-555-7258 5002 Shipped </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #5 Returning SQL data as part of a larger XML document</b></p> <div class='example-contents para'><p> The following example works with a portion of the PRODUCT.DESCRIPTION documents in the SAMPLE database. It creates a XML document containing product description (XML data) and pricing info (SQL data). </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />SELECT<br />XMLSERIALIZE(<br />XMLQUERY(\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;declare&amp;nbsp;boundary-space&amp;nbsp;strip;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;declare&amp;nbsp;default&amp;nbsp;element&amp;nbsp;namespace&amp;nbsp;'http://posample.org';<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoList&amp;gt;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for&amp;nbsp;$prod&amp;nbsp;in&amp;nbsp;$doc/product<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;where&amp;nbsp;$prod/description/price&amp;nbsp;&amp;lt;&amp;nbsp;10.00<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;order&amp;nbsp;by&amp;nbsp;$prod/description/price&amp;nbsp;ascending<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoitem&amp;gt;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$prod,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;startdate&amp;gt;&amp;nbsp;{$start}&amp;nbsp;&amp;lt;/startdate&amp;gt;,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;enddate&amp;gt;&amp;nbsp;{$end}&amp;nbsp;&amp;lt;/enddate&amp;gt;,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoprice&amp;gt;&amp;nbsp;{$promo}&amp;nbsp;&amp;lt;/promoprice&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;lt;/promoitem&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;lt;/promoList&amp;gt;<br />\'&amp;nbsp;passing&amp;nbsp;by&amp;nbsp;ref&amp;nbsp;DESCRIPTION&amp;nbsp;AS&amp;nbsp;'doc',<br />PROMOSTART&amp;nbsp;as&amp;nbsp;'start',<br />PROMOEND&amp;nbsp;as&amp;nbsp;'end',<br />PROMOPRICE&amp;nbsp;as&amp;nbsp;'promo'<br />RETURNING&amp;nbsp;SEQUENCE)<br />AS&amp;nbsp;CLOB&amp;nbsp;(32000))<br />AS&amp;nbsp;NEW_PRODUCT_INFO<br />FROM&amp;nbsp;PRODUCT<br />WHERE&amp;nbsp;PID&amp;nbsp;=&amp;nbsp;?<br />'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$pid&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'100-100-01'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'pid'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /><br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;promoList xmlns=&amp;quot;http://posample.org&amp;quot;&amp;gt; &amp;lt;promoitem&amp;gt; &amp;lt;product pid=&amp;quot;100-100-01&amp;quot;&amp;gt; &amp;lt;description&amp;gt; &amp;lt;name&amp;gt;Snow Shovel, Basic 22 inch&amp;lt;/name&amp;gt; &amp;lt;details&amp;gt;Basic Snow Shovel, 22 inches wide, straight handle with D-Grip&amp;lt;/details&amp;gt; &amp;lt;price&amp;gt;9.99&amp;lt;/price&amp;gt; &amp;lt;weight&amp;gt;1 kg&amp;lt;/weight&amp;gt; &amp;lt;/description&amp;gt; &amp;lt;/product&amp;gt; &amp;lt;startdate&amp;gt;2004-11-19&amp;lt;/startdate&amp;gt; &amp;lt;enddate&amp;gt;2004-12-19&amp;lt;/enddate&amp;gt; &amp;lt;promoprice&amp;gt;7.25&amp;lt;/promoprice&amp;gt; &amp;lt;/promoitem&amp;gt; &amp;lt;/promoList&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.db2-execute.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-exec.php' class='function' rel='rdfs-seeAlso'>db2_exec()</a> - Executes an SQL statement directly</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-array.php' class='function' rel='rdfs-seeAlso'>db2_fetch_array()</a> - Returns an array, indexed by column position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-assoc.php' class='function' rel='rdfs-seeAlso'>db2_fetch_assoc()</a> - Returns an array, indexed by column name, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-both.php' class='function' rel='rdfs-seeAlso'>db2_fetch_both()</a> - Returns an array, indexed by both column name and position, representing a row in a result set</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-fetch-row.php' class='function' rel='rdfs-seeAlso'>db2_fetch_row()</a> - Sets the result set pointer to the next row or requested row</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-result.php' class='function' rel='rdfs-seeAlso'>db2_result()</a> - Returns a single column from a row in the result set</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_exec" value="<div id='function.db2-exec' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-exec.php'>db2_exec</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_exec</span> &amp;mdash; <span class='dc-title'> Executes an SQL statement directly </span></p> </div> <a name='function.db2-exec.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_exec</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$statement</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$options</tt></span> ] )</div> <p class='para rdfs-comment'> Executes an SQL statement directly. </p> <p class='para'> If you plan to interpolate PHP variables into the SQL statement, understand that this is one of the more common security exposures. Consider calling <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> to prepare an SQL statement with parameter markers for input values. Then you can call <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a> to pass in the input values and avoid SQL injection attacks. </p> <p class='para'> If you plan to repeatedly issue the same SQL statement with different parameters, consider calling <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a> and <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a> to enable the database server to reuse its access plan and increase the efficiency of your database access. </p> </div> <a name='function.db2-exec.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid database connection resource variable as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>statement</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An SQL statement. The statement cannot contain any parameter markers. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array containing statement options. You can use this parameter to request a scrollable cursor on database servers that support this functionality. </p> <p class='para'> For a description of valid statement options, see <a href='http://www.php.net/manual/en/function.db2-set-option.php' class='function'>db2_set_option()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-exec.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource if the SQL statement was issued successfully, or <b><tt class='constant'>FALSE</tt></b> if the database failed to execute the SQL statement. </p> </div> <a name='function.db2-exec.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating a table with <b>db2_exec()</b></b></p> <div class='example-contents para'><p> The following example uses <b>db2_exec()</b> to issue a set of DDL statements in the process of creating a table. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Create&amp;nbsp;the&amp;nbsp;test&amp;nbsp;table<br /></span><span style='color: #0000BB'>$create&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CREATE&amp;nbsp;TABLE&amp;nbsp;animals&amp;nbsp;(id&amp;nbsp;INTEGER,&amp;nbsp;breed&amp;nbsp;VARCHAR(32),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;name&amp;nbsp;CHAR(16),&amp;nbsp;weight&amp;nbsp;DECIMAL(7,2))'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$create</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Successfully&amp;nbsp;created&amp;nbsp;the&amp;nbsp;table.\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Populate&amp;nbsp;the&amp;nbsp;test&amp;nbsp;table<br /></span><span style='color: #0000BB'>$animals&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>0</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'cat'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Pook'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3.2</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'dog'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Peaches'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>12.3</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'horse'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Smarty'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>350.0</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'gold&amp;nbsp;fish'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Bubbles'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0.1</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>4</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'budgerigar'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Gizmo'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>0.2</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>5</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'goat'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Rickety&amp;nbsp;Ride'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>9.7</span><span style='color: #007700'>),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;array(</span><span style='color: #0000BB'>6</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'llama'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'Sweater'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>150</span><span style='color: #007700'>)<br />);<br /><br />foreach&amp;nbsp;(</span><span style='color: #0000BB'>$animals&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;animals&amp;nbsp;(id,&amp;nbsp;breed,&amp;nbsp;name,&amp;nbsp;weight)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;VALUES&amp;nbsp;(</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>',&amp;nbsp;'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>',&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$animal</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>)'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>$rc</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Insert...&amp;nbsp;'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Successfully created the table. Insert... Insert... Insert... Insert... Insert... Insert... Insert... </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Executing a SELECT statement with a scrollable cursor</b></p> <div class='example-contents para'><p> The following example demonstrates how to request a scrollable cursor for an SQL statement issued by <b>db2_exec()</b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;name&amp;nbsp;FROM&amp;nbsp;animals<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;weight&amp;nbsp;&amp;lt;&amp;nbsp;10.0<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;ORDER&amp;nbsp;BY&amp;nbsp;name'</span><span style='color: #007700'>;<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;require_once(</span><span style='color: #DD0000'>'prepare.inc'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'cursor'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_SCROLLABLE</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}&amp;nbsp;<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Bubbles Gizmo Pook Rickety Ride </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 Returning XML data as a SQL ResultSet</b></p> <div class='example-contents para'><p> The following example demonstrates how to work with documents stored in a XML column using the SAMPLE database. Using some pretty simple SQL/XML, this example returns some of the nodes in a XML document in a SQL ResultSet format that most users are familiar with. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;*&amp;nbsp;FROM&amp;nbsp;XMLTABLE(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;\'db2-fn:xmlcolumn('CUSTOMER.INFO')/customerinfo\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;COLUMNS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'CID'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'@Cid\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'NAME'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'name\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'PHONE'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'phone&amp;nbsp;[&amp;nbsp;@type&amp;nbsp;=&amp;nbsp;'work']\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)&amp;nbsp;AS&amp;nbsp;T<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;NAME&amp;nbsp;=&amp;nbsp;\'Kathy&amp;nbsp;Smith\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CID</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NAME</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PHONE</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1000 Kathy Smith 416-555-1358 1001 Kathy Smith 905-555-7258 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #4 Performing a &amp;quot;JOIN&amp;quot; with XML data</b></p> <div class='example-contents para'><p> The following example works with documents stored in 2 different XML columns in the SAMPLE database. It creates 2 temporary tables from the XML documents from 2 different columns and returns a SQL ResultSet with information regarding shipping status for the customer. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;SELECT&amp;nbsp;A.CID,&amp;nbsp;A.NAME,&amp;nbsp;A.PHONE,&amp;nbsp;C.PONUM,&amp;nbsp;C.STATUS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;FROM<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLTABLE(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;\'db2-fn:xmlcolumn('CUSTOMER.INFO')/customerinfo\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;COLUMNS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'CID'&amp;nbsp;BIGINT&amp;nbsp;PATH&amp;nbsp;\'@Cid\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'NAME'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'name\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'PHONE'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'phone&amp;nbsp;[&amp;nbsp;@type&amp;nbsp;=&amp;nbsp;'work']\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)&amp;nbsp;as&amp;nbsp;A,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;PURCHASEORDER&amp;nbsp;AS&amp;nbsp;B,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLTABLE&amp;nbsp;(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;XMLNAMESPACES&amp;nbsp;(DEFAULT&amp;nbsp;\'http://posample.org\'),<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;\'db2-fn:xmlcolumn('PURCHASEORDER.PORDER')/PurchaseOrder\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;COLUMNS<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'PONUM'&amp;nbsp;&amp;nbsp;BIGINT&amp;nbsp;PATH&amp;nbsp;\'@PoNum\',<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;'STATUS'&amp;nbsp;VARCHAR&amp;nbsp;(50)&amp;nbsp;PATH&amp;nbsp;\'@Status\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)&amp;nbsp;as&amp;nbsp;C<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;A.CID&amp;nbsp;=&amp;nbsp;B.CUSTID&amp;nbsp;AND<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;B.POID&amp;nbsp;=&amp;nbsp;C.PONUM&amp;nbsp;AND<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;A.NAME&amp;nbsp;=&amp;nbsp;\'Kathy&amp;nbsp;Smith\'<br />'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_object</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CID</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>NAME</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PHONE</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>PONUM</span><span style='color: #DD0000'>&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>STATUS</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />}<br /><br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 1001 Kathy Smith 905-555-7258 5002 Shipped </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #5 Returning SQL data as part of a larger XML document</b></p> <div class='example-contents para'><p> The following example works with a portion of the PRODUCT.DESCRIPTION documents in the SAMPLE database. It creates a XML document containing product description (XML data) and pricing info (SQL data). </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$query&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'<br />SELECT<br />XMLSERIALIZE(<br />XMLQUERY(\'<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;declare&amp;nbsp;boundary-space&amp;nbsp;strip;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;declare&amp;nbsp;default&amp;nbsp;element&amp;nbsp;namespace&amp;nbsp;'http://posample.org';<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoList&amp;gt;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;for&amp;nbsp;$prod&amp;nbsp;in&amp;nbsp;$doc/product<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;where&amp;nbsp;$prod/description/price&amp;nbsp;&amp;lt;&amp;nbsp;10.00<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;order&amp;nbsp;by&amp;nbsp;$prod/description/price&amp;nbsp;ascending<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;return(<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoitem&amp;gt;&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;$prod,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;startdate&amp;gt;&amp;nbsp;{$start}&amp;nbsp;&amp;lt;/startdate&amp;gt;,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;enddate&amp;gt;&amp;nbsp;{$end}&amp;nbsp;&amp;lt;/enddate&amp;gt;,<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;promoprice&amp;gt;&amp;nbsp;{$promo}&amp;nbsp;&amp;lt;/promoprice&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;lt;/promoitem&amp;gt;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;)<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;lt;/promoList&amp;gt;<br />\'&amp;nbsp;passing&amp;nbsp;by&amp;nbsp;ref&amp;nbsp;DESCRIPTION&amp;nbsp;AS&amp;nbsp;'doc',<br />PROMOSTART&amp;nbsp;as&amp;nbsp;'start',<br />PROMOEND&amp;nbsp;as&amp;nbsp;'end',<br />PROMOPRICE&amp;nbsp;as&amp;nbsp;'promo'<br />RETURNING&amp;nbsp;SEQUENCE)<br />AS&amp;nbsp;CLOB&amp;nbsp;(32000))<br />AS&amp;nbsp;NEW_PRODUCT_INFO<br />FROM&amp;nbsp;PRODUCT<br />WHERE&amp;nbsp;PID&amp;nbsp;=&amp;nbsp;\'100-100-01\'<br />'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$query</span><span style='color: #007700'>);<br /><br />while(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>)){<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>printf</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>);<br />}<br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> &amp;lt;promoList xmlns=&amp;quot;http://posample.org&amp;quot;&amp;gt; &amp;lt;promoitem&amp;gt; &amp;lt;product pid=&amp;quot;100-100-01&amp;quot;&amp;gt; &amp;lt;description&amp;gt; &amp;lt;name&amp;gt;Snow Shovel, Basic 22 inch&amp;lt;/name&amp;gt; &amp;lt;details&amp;gt;Basic Snow Shovel, 22 inches wide, straight handle with D-Grip&amp;lt;/details&amp;gt; &amp;lt;price&amp;gt;9.99&amp;lt;/price&amp;gt; &amp;lt;weight&amp;gt;1 kg&amp;lt;/weight&amp;gt; &amp;lt;/description&amp;gt; &amp;lt;/product&amp;gt; &amp;lt;startdate&amp;gt;2004-11-19&amp;lt;/startdate&amp;gt; &amp;lt;enddate&amp;gt;2004-12-19&amp;lt;/enddate&amp;gt; &amp;lt;promoprice&amp;gt;7.25&amp;lt;/promoprice&amp;gt; &amp;lt;/promoitem&amp;gt; &amp;lt;/promoList&amp;gt; </pre></div> </div> </div><p> </p> </div> <a name='function.db2-exec.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-execute.php' class='function' rel='rdfs-seeAlso'>db2_execute()</a> - Executes a prepared SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_escape_string" value="<div id='function.db2-escape-string' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-escape-string.php'>db2_escape_string</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.6.0)</p><p class='refpurpose'><span class='refname'>db2_escape_string</span> &amp;mdash; <span class='dc-title'> Used to escape certain characters </span></p> </div> <a name='function.db2-escape-string.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_escape_string</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$string_literal</tt></span> )</div> <p class='para rdfs-comment'> Prepends backslashes to special characters in the string argument. </p> </div> <a name='function.db2-escape-string.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'>string_literal</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The string that contains special characters that need to be modified. Characters that are prepended with a backslash are <i>\x00</i>, <i>\n</i>, <i>\r</i>, <i>\</i>, <i>&amp;#039;</i>, <i>&amp;quot;</i> and <i>\x1a</i>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-escape-string.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <i><tt class='parameter'>string_literal</tt></i> with the special characters noted above prepended with backslashes. </p> </div> <a name='function.db2-escape-string.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_escape_string()</b> example</b></p> <div class='example-contents para'><p> Result of using the <b>db2_escape_string()</b> function </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'All&amp;nbsp;characters:&amp;nbsp;\x00&amp;nbsp;,&amp;nbsp;\n&amp;nbsp;,&amp;nbsp;\r&amp;nbsp;,&amp;nbsp;\&amp;nbsp;,&amp;nbsp;'&amp;nbsp;,&amp;nbsp;\'&amp;nbsp;,&amp;nbsp;\x1a&amp;nbsp;.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'Backslash&amp;nbsp;(\).&amp;nbsp;Single&amp;nbsp;quote&amp;nbsp;(').&amp;nbsp;Double&amp;nbsp;quote&amp;nbsp;(\')'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'The&amp;nbsp;NULL&amp;nbsp;character&amp;nbsp;\0&amp;nbsp;must&amp;nbsp;be&amp;nbsp;quoted&amp;nbsp;as&amp;nbsp;well'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>3</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'Intersting&amp;nbsp;characters:&amp;nbsp;\x1a&amp;nbsp;,&amp;nbsp;\x00&amp;nbsp;.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>4</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>'Nothing&amp;nbsp;to&amp;nbsp;quote'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>5</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #0000BB'>200676</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$str</span><span style='color: #007700'>[</span><span style='color: #0000BB'>6</span><span style='color: #007700'>]&amp;nbsp;=&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;foreach(&amp;nbsp;</span><span style='color: #0000BB'>$str&amp;nbsp;</span><span style='color: #007700'>as&amp;nbsp;</span><span style='color: #0000BB'>$string&amp;nbsp;</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'db2_escape_string:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>db2_escape_string</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$string</span><span style='color: #007700'>).&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> db2_escape_string: All characters: \0 , \n , \r , \\ , \&amp;#039; , \&amp;quot; , \Z . db2_escape_string: Backslash (\\). Single quote (\&amp;#039;). Double quote (\&amp;quot;) db2_escape_string: The NULL character \0 must be quoted as well db2_escape_string: Intersting characters: \Z , \0 . db2_escape_string: Nothing to quote db2_escape_string: 200676 db2_escape_string: </pre></div> </div> </div><p> </p> </div> <a name='function.db2-escape-string.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_cursor_type" value="<div id='function.db2-cursor-type' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-cursor-type.php'>db2_cursor_type</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_cursor_type</span> &amp;mdash; <span class='dc-title'> Returns the cursor type used by a statement resource </span></p> </div> <a name='function.db2-cursor-type.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>db2_cursor_type</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> )</div> <p class='para rdfs-comment'> Returns the cursor type used by a statement resource. Use this to determine if you are working with a forward-only cursor or scrollable cursor. </p> </div> <a name='function.db2-cursor-type.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid statement resource. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-cursor-type.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns either <i>DB2_FORWARD_ONLY</i> if the statement resource uses a forward-only cursor or <i>DB2_SCROLLABLE</i> if the statement resource uses a scrollable cursor. </p> </div> <a name='function.db2-cursor-type.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_connect" value="<div id='function.db2-connect' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-connect.php'>db2_connect</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_connect</span> &amp;mdash; <span class='dc-title'> Returns a connection to a database </span></p> </div> <a name='function.db2-connect.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_connect</b></span> ( <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$database</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$username</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$password</tt></span> [, <span class='methodparam'><span class='type'>array</span> <tt class='parameter'>$options</tt></span> ] )</div> <p class='para rdfs-comment'> Creates a new connection to an IBM DB2 Universal Database, IBM Cloudscape, or Apache Derby database. </p> </div> <a name='function.db2-connect.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'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> For a cataloged connection to a database, <i><tt class='parameter'>database</tt></i> represents the database alias in the DB2 client catalog. </p> <p class='para'> For an uncataloged connection to a database, <i><tt class='parameter'>database</tt></i> represents a complete connection string in the following format: <pre class='literallayout'>DATABASE=<i><tt class='parameter'>database</tt></i> ;HOSTNAME=<i><tt class='parameter'>hostname</tt></i> ;PORT=<i><tt class='parameter'>port</tt></i> ;PROTOCOL=TCPIP;UID=<i><tt class='parameter'>username</tt></i> ;PWD=<i><tt class='parameter'>password</tt></i> ;</pre> where the parameters represent the following values: </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>database</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>hostname</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The hostname or IP address of the database server. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>port</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The TCP/IP port on which the database is listening for requests. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username with which you are connecting to the database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password with which you are connecting to the database. </p> </dd> </dl> <p> </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>username</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The username with which you are connecting to the database. </p> <p class='para'> For uncataloged connections, you must pass a <b><tt class='constant'>NULL</tt></b> value or empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>password</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The password with which you are connecting to the database. </p> <p class='para'> For uncataloged connections, you must pass a <b><tt class='constant'>NULL</tt></b> value or empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>options</tt></i> </span> </dt><dd class='listitem'> <p class='para'> An associative array of connection options that affect the behavior of the connection, where valid array keys include: </p><dl> <dt class='varlistentry'> <br /><span class='term'><i><tt class='parameter'>autocommit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_AUTOCOMMIT_ON</i> value turns autocommit on for this connection handle. </p> <p class='para'> Passing the <i>DB2_AUTOCOMMIT_OFF</i> value turns autocommit off for this connection handle. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>DB2_ATTR_CASE</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_CASE_NATURAL</i> value specifies that column names are returned in natural case. </p> <p class='para'> Passing the <i>DB2_CASE_LOWER</i> value specifies that column names are returned in lower case. </p> <p class='para'> Passing the <i>DB2_CASE_UPPER</i> value specifies that column names are returned in upper case. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>CURSOR</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the <i>DB2_FORWARD_ONLY</i> value specifies a forward-only cursor for a statement resource. This is the default cursor type and is supported on all database servers. </p> <p class='para'> Passing the <i>DB2_SCROLLABLE</i> value specifies a scrollable cursor for a statement resource. This mode enables random access to rows in a result set, but currently is supported only by IBM DB2 Universal Database. </p> </dd> </dl> <p> </p> <p class='para'> The following new option is available in ibm_db2 version 1.7.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>trustedcontext</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Passing the DB2_TRUSTED_CONTEXT_ENABLE value turns trusted context on for this connection handle. This parameter cannot be set using <a href='http://www.php.net/manual/en/function.db2-set-option.php' class='function'>db2_set_option()</a>. </p> <p class='para'> This key works only if the database is cataloged (even if the database is local), or if you specify the full DSN when you create the connection. </p> <p class='para'> To catalog the database, use following commands: </p> <p class='para'> <pre class='literallayout'>db2 catalog tcpip node loopback remote &amp;lt;SERVERNAME&amp;gt; server &amp;lt;SERVICENAME&amp;gt; db2 catalog database &amp;lt;LOCALDBNAME&amp;gt; as &amp;lt;REMOTEDBNAME&amp;gt; at node loopback db2 &amp;quot;update dbm cfg using svcename &amp;lt;SERVICENAME&amp;gt;&amp;quot; db2set DB2COMM=TCPIP</pre> </p> </dd> </dl> <p> </p> <p class='para'> The following new i5/OS options are available in ibm_db2 version 1.5.1 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_lib</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A character value that indicates the default library that will be used for resolving unqualified file references. This is not valid if the connection is using system naming mode. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_naming</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_NAMING_ON</i> value turns on DB2 UDB CLI iSeries system naming mode. Files are qualified using the slash (/) delimiter. Unqualified files are resolved using the library list for the job. </p> <p class='para'> <i>DB2_I5_NAMING_OFF</i> value turns off DB2 UDB CLI default naming mode, which is SQL naming. Files are qualified using the period (.) delimiter. Unqualified files are resolved using either the default library or the current user ID. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_commit</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The <i><tt class='parameter'>i5_commit</tt></i> attribute should be set before the <b>db2_connect()</b>. If the value is changed after the connection has been established, and the connection is to a remote data source, the change does not take effect until the next successful <b>db2_connect()</b> for the connection handle. </p><blockquote><p><b class='note'>Note</b>: The php.ini setting <i><tt class='parameter'>ibm_db2.i5_allow_commit</tt></i> ==0 or <i>DB2_I5_TXN_NO_COMMIT</i> is the default, but may be overridden with the <i><tt class='parameter'>i5_commit</tt></i> option. <br /> </p></blockquote><p> </p> <p class='para'> <i>DB2_I5_TXN_NO_COMMIT</i> - Commitment control is not used. </p> <p class='para'> <i>DB2_I5_TXN_READ_UNCOMMITTED</i> - Dirty reads, nonrepeatable reads, and phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_READ_COMMITTED</i> - Dirty reads are not possible. Nonrepeatable reads, and phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_REPEATABLE_READ</i> - Dirty reads and nonrepeatable reads are not possible. Phantoms are possible. </p> <p class='para'> <i>DB2_I5_TXN_SERIALIZABLE</i> - Transactions are serializable. Dirty reads, non-repeatable reads, and phantoms are not possible </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_query_optimize</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_FIRST_IO</i> All queries are optimized with the goal of returning the first page of output as fast as possible. This goal works well when the output is controlled by a user who is most likely to cancel the query after viewing the first page of output data. Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. </p> <p class='para'> <i>DB2_ALL_IO</i> All queries are optimized with the goal of running the entire query to completion in the shortest amount of elapsed time. This is a good option when the output of a query is being written to a file or report, or the interface is queuing the output data. Queries coded with an OPTIMIZE FOR nnn ROWS clause honor the goal specified by the clause. This is the default. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_dbcs_alloc</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_DBCS_ALLOC_ON</i> value turns on DB2 6X allocation scheme for DBCS translation column size growth. </p> <p class='para'> <i>DB2_I5_DBCS_ALLOC_OFF</i> value turns off DB2 6X allocation scheme for DBCS translation column size growth. </p> <p class='para'> Note: php.ini setting <i><tt class='parameter'>ibm_db2.i5_dbcs_alloc</tt></i> ==0 or <i>DB2_I5_DBCS_ALLOC_OFF</i> is the default, but may be overridden with the <i><tt class='parameter'>i5_dbcs_alloc</tt></i> option. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_date_fmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_FMT_ISO</i> - The International Organization for Standardization (ISO) date format yyyy-mm-dd is used. This is the default. </p> <p class='para'> <i>DB2_I5_FMT_USA</i> - The United States date format mm/dd/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_EUR</i> - The European date format dd.mm.yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_JIS</i> - The Japanese Industrial Standard date format yyyy-mm-dd is used. </p> <p class='para'> <i>DB2_I5_FMT_MDY</i> - The date format mm/dd/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_DMY</i> - The date format dd/mm/yyyy is used. </p> <p class='para'> <i>DB2_I5_FMT_YMD</i> - The date format yy/mm/dd is used. </p> <p class='para'> <i>DB2_I5_FMT_JUL</i> - The Julian date format yy/ddd is used. </p> <p class='para'> <i>DB2_I5_FMT_JOB</i> - The job default is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_date_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_SLASH</i> - A slash ( / ) is used as the date separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_DASH</i> - A dash ( - ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_BLANK</i> - A blank is used as the date separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_time_fmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_FMT_ISO</i> - The International Organization for Standardization (ISO) time format hh.mm.ss is used. This is the default. </p> <p class='para'> <i>DB2_I5_FMT_USA</i> - The United States time format hh:mmxx is used, where xx is AM or PM. </p> <p class='para'> <i>DB2_I5_FMT_EUR</i> - The European time format hh.mm.ss is used. </p> <p class='para'> <i>DB2_I5_FMT_JIS</i> - The Japanese Industrial Standard time format hh:mm:ss is used. </p> <p class='para'> <i>DB2_I5_FMT_HMS</i> - The hh:mm:ss format is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_time_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_COLON</i> - A colon ( : ) is used as the time separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_BLANK</i> - A blank is used as the time separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_decimal_sep</tt></i> </span> </dt><dd class='listitem'> <p class='para'> <i>DB2_I5_SEP_PERIOD</i> - A period ( . ) is used as the decimal separator. This is the default. </p> <p class='para'> <i>DB2_I5_SEP_COMMA</i> - A comma ( , ) is used as the decimal separator. </p> <p class='para'> <i>DB2_I5_SEP_JOB</i> - The job default is used. </p> </dd> </dl> <p> </p> <p class='para'> The following new i5/OS option is available in ibm_db2 version 1.8.0 and later. </p><dl> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>i5_libl</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A character value that indicates the library list that will be used for resolving unqualified file references. Specify the library list elements separated by blanks &amp;#039;i5_libl&amp;#039;=&amp;gt;&amp;quot;MYLIB YOURLIB ANYLIB&amp;quot;. </p> <blockquote><p><b class='note'>Note</b>: <i><tt class='parameter'>i5_libl</tt></i> calls qsys2/qcmdexc(&amp;#039;cmd&amp;#039;,cmdlen), which is only available in i5/OS V5R4 and later. <br /> </p></blockquote> </dd> </dl> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.db2-connect.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a connection handle resource if the connection attempt is successful. If the connection attempt fails, <b>db2_connect()</b> returns <b><tt class='constant'>FALSE</tt></b>. </p> </div> <a name='function.db2-connect.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Creating a cataloged connection</b></p> <div class='example-contents para'><p> Cataloged connections require you to have previously cataloged the target database through the DB2 Command Line Processor (CLP) or DB2 Configuration Assistant. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;succeeded.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connection succeeded. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Creating an uncataloged connection</b></p> <div class='example-contents para'><p> An uncataloged connection enables you to dynamically connect to a database. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$conn_string&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER={IBM&amp;nbsp;DB2&amp;nbsp;ODBC&amp;nbsp;DRIVER};DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;'&amp;nbsp;</span><span style='color: #007700'>.<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;PROTOCOL=TCPIP;UID=</span><span style='color: #0000BB'>$user</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$password</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn_string</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;succeeded.'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connection succeeded. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 Creating a connection with autocommit off by default</b></p> <div class='example-contents para'><p> Passing an array of options to <b>db2_connect()</b> enables you to modify the default behavior of the connection handle. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$password&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;succeeded.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if&amp;nbsp;(</span><span style='color: #0000BB'>db2_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Autocommit&amp;nbsp;is&amp;nbsp;on.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Autocommit&amp;nbsp;is&amp;nbsp;off.\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;failed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connection succeeded. Autocommit is off. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #4 i5/OS best performance</b></p> <div class='example-contents para'><p> To achieve best performance for your i5/OS ibm_db2 1.5.1 PHP application use the default host, userid, and password for your <b>db2_connect()</b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />&amp;nbsp;&amp;nbsp;$library&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ADC'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$i5&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;array(</span><span style='color: #DD0000'>'i5_lib'</span><span style='color: #007700'>=&amp;gt;</span><span style='color: #DD0000'>'qsys2'</span><span style='color: #007700'>));<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$result&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_exec</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$i5</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'select&amp;nbsp;*&amp;nbsp;from&amp;nbsp;systables&amp;nbsp;where&amp;nbsp;table_schema&amp;nbsp;=&amp;nbsp;'</span><span style='color: #0000BB'>$library</span><span style='color: #DD0000'>''</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_both</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$result</span><span style='color: #007700'>))&amp;nbsp;{&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #DD0000'>'TABLE_NAME'</span><span style='color: #007700'>].</span><span style='color: #DD0000'>'&amp;lt;/br&amp;gt;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;}&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$i5</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> ANIMALS NAMES PICTURES </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #5 Using trusted context</b></p> <div class='example-contents para'><p> The following example shows how to enable trusted context, switch users, and get the current user ID. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$database&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$hostname&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'localhost'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$port&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>50000</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$authID&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$auth_pass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$tc_user&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'tcuser'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$tc_pass&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'tcpassword'</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>$dsn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'DATABASE=</span><span style='color: #0000BB'>$database</span><span style='color: #DD0000'>;HOSTNAME=</span><span style='color: #0000BB'>$hostname</span><span style='color: #DD0000'>;PORT=</span><span style='color: #0000BB'>$port</span><span style='color: #DD0000'>;<br />&amp;nbsp;&amp;nbsp;PROTOCOL=TCPIP;UID=</span><span style='color: #0000BB'>$authID</span><span style='color: #DD0000'>;PWD=</span><span style='color: #0000BB'>$auth_pass</span><span style='color: #DD0000'>;'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array&amp;nbsp;(</span><span style='color: #DD0000'>'trustedcontext'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_TRUSTED_CONTEXT_ENABLE</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$tc_conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$dsn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>''</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>);<br />if(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Explicit&amp;nbsp;trusted&amp;nbsp;connection&amp;nbsp;succeeded.\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;if(</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trustedcontext'</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$userBefore&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trusted_user'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//Do&amp;nbsp;some&amp;nbsp;work&amp;nbsp;as&amp;nbsp;user&amp;nbsp;1.<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;//Switching&amp;nbsp;to&amp;nbsp;trusted&amp;nbsp;user.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$parameters&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'trusted_user'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$tc_user</span><span style='color: #007700'>,&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #DD0000'>'trusted_password'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>$tcuser_pass</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$res&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_set_option&amp;nbsp;</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$parameters</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>);<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>$userAfter&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_get_option</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'trusted_user'</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #FF8000'>//Do&amp;nbsp;more&amp;nbsp;work&amp;nbsp;as&amp;nbsp;trusted&amp;nbsp;user.<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>if(</span><span style='color: #0000BB'>$userBefore&amp;nbsp;</span><span style='color: #007700'>!=&amp;nbsp;</span><span style='color: #0000BB'>$userAfter</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'User&amp;nbsp;has&amp;nbsp;been&amp;nbsp;switched.'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #DD0000'>'\n'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$tc_conn</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Explicit&amp;nbsp;trusted&amp;nbsp;connection&amp;nbsp;failed.\n'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Explicit trusted connection succeeded. User has been switched. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-connect.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-close.php' class='function' rel='rdfs-seeAlso'>db2_close()</a> - Closes a database connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_conn_errormsg" value="<div id='function.db2-conn-errormsg' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-conn-errormsg.php'>db2_conn_errormsg</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_conn_errormsg</span> &amp;mdash; <span class='dc-title'> Returns the last connection error message and SQLCODE value </span></p> </div> <a name='function.db2-conn-errormsg.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_conn_errormsg</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>db2_conn_errormsg()</b> returns an error message and SQLCODE value representing the reason the last database connection attempt failed. As <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> returns <b><tt class='constant'>FALSE</tt></b> in the event of a failed connection attempt, do not pass any parameters to <b>db2_conn_errormsg()</b> to retrieve the associated error message and SQLCODE value. </p> <p class='para'> If, however, the connection was successful but becomes invalid over time, you can pass the <i><tt class='parameter'>connection</tt></i> parameter to retrieve the associated error message and SQLCODE value for a specific connection. </p> </div> <a name='function.db2-conn-errormsg.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A connection resource associated with a connection that initially succeeded, but which over time became invalid. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-conn-errormsg.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a string containing the error message and SQLCODE value resulting from a failed connection attempt. If there is no error associated with the last connection attempt, <b>db2_conn_errormsg()</b> returns an empty string. </p> </div> <a name='function.db2-conn-errormsg.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Retrieving the error message returned by a failed connection attempt</b></p> <div class='example-contents para'><p> The following example demonstrates how to return an error message and SQLCODE value after deliberately passing invalid parameters to <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'badname'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'baduser'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'badpassword'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #0000BB'>db2_conn_errormsg</span><span style='color: #007700'>();<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> [IBM][CLI Driver] SQL1013N The database alias name or database name &amp;quot;BADNAME&amp;quot; could not be found. SQLSTATE=42705 SQLCODE=-1013 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-conn-errormsg.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-error.php' class='function' rel='rdfs-seeAlso'>db2_conn_error()</a> - Returns a string containing the SQLSTATE returned by the last connection attempt</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-error.php' class='function' rel='rdfs-seeAlso'>db2_stmt_error()</a> - Returns a string containing the SQLSTATE returned by an SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_stmt_errormsg()</a> - Returns a string containing the last SQL statement error message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_conn_error" value="<div id='function.db2-conn-error' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-conn-error.php'>db2_conn_error</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_conn_error</span> &amp;mdash; <span class='dc-title'> Returns a string containing the SQLSTATE returned by the last connection attempt </span></p> </div> <a name='function.db2-conn-error.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>string</span> <span class='methodname'><b>db2_conn_error</b></span> ([ <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> ] )</div> <p class='para rdfs-comment'> <b>db2_conn_error()</b> returns an SQLSTATE value representing the reason the last attempt to connect to a database failed. As <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> returns <b><tt class='constant'>FALSE</tt></b> in the event of a failed connection attempt, you do not pass any parameters to <b>db2_conn_error()</b> to retrieve the SQLSTATE value. </p> <p class='para'> If, however, the connection was successful but becomes invalid over time, you can pass the <i><tt class='parameter'>connection</tt></i> parameter to retrieve the SQLSTATE value for a specific connection. </p> <p class='para'> To learn what the SQLSTATE value means, you can issue the following command at a DB2 Command Line Processor prompt: <strong class='userinput'><code>db2 &amp;#039;? <i><tt class='parameter'>sqlstate-value</tt></i> &amp;#039;</code></strong> . You can also call <a href='http://www.php.net/manual/en/function.db2-conn-errormsg.php' class='function'>db2_conn_errormsg()</a> to retrieve an explicit error message and the associated SQLCODE value. </p> </div> <a name='function.db2-conn-error.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A connection resource associated with a connection that initially succeeded, but which over time became invalid. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-conn-error.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns the SQLSTATE value resulting from a failed connection attempt. Returns an empty string if there is no error associated with the last connection attempt. </p> </div> <a name='function.db2-conn-error.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Retrieving an SQLSTATE value for a failed connection attempt</b></p> <div class='example-contents para'><p> The following example demonstrates how to return an SQLSTATE value after deliberately passing invalid parameters to <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'badname'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'baduser'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'badpassword'</span><span style='color: #007700'>);<br />if&amp;nbsp;(!</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'SQLSTATE&amp;nbsp;value:&amp;nbsp;'&amp;nbsp;</span><span style='color: #007700'>.&amp;nbsp;</span><span style='color: #0000BB'>db2_conn_error</span><span style='color: #007700'>();<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> SQLSTATE value: 08001 </pre></div> </div> </div><p> </p> </div> <a name='function.db2-conn-error.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-conn-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_conn_errormsg()</a> - Returns the last connection error message and SQLCODE value</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-error.php' class='function' rel='rdfs-seeAlso'>db2_stmt_error()</a> - Returns a string containing the SQLSTATE returned by an SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-stmt-errormsg.php' class='function' rel='rdfs-seeAlso'>db2_stmt_errormsg()</a> - Returns a string containing the last SQL statement error message</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_commit" value="<div id='function.db2-commit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-commit.php'>db2_commit</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_commit</span> &amp;mdash; <span class='dc-title'> Commits a transaction </span></p> </div> <a name='function.db2-commit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_commit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> Commits an in-progress transaction on the specified connection resource and begins a new transaction. PHP applications normally default to AUTOCOMMIT mode, so <b>db2_commit()</b> is not necessary unless AUTOCOMMIT has been turned off for the connection resource. </p> <blockquote><p><b class='note'>Note</b>: If the specified connection resource is a persistent connection, all transactions in progress for all applications using that persistent connection will be committed. For this reason, persistent connections are not recommended for use in applications that require transactions. <br /> </p></blockquote> </div> <a name='function.db2-commit.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid database connection resource variable as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-commit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-commit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-autocommit.php' class='function' rel='rdfs-seeAlso'>db2_autocommit()</a> - Returns or sets the AUTOCOMMIT state for a database connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-rollback.php' class='function' rel='rdfs-seeAlso'>db2_rollback()</a> - Rolls back a transaction</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_columns" value="<div id='function.db2-columns' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-columns.php'>db2_columns</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_columns</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the columns and associated metadata for a table </span></p> </div> <a name='function.db2-columns.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_columns</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column-name</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Returns a result set listing the columns and associated metadata for a table. </p> </div> <a name='function.db2-columns.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. To match all schemas, pass <i>&amp;#039;%&amp;#039;</i>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table or view. To match all tables in the database, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the column. To match all columns in the table, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-columns.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the columns matching the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'>Name of the catalog. The value is NULL if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'>Name of the schema.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table or view.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>Name of the column.</td> </tr> <tr valign='middle'> <td align='left'>DATA_TYPE</td> <td align='left'>The SQL data type for the column represented as an integer value.</td> </tr> <tr valign='middle'> <td align='left'>TYPE_NAME</td> <td align='left'>A string representing the data type for the column.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_SIZE</td> <td align='left'>An integer value representing the size of the column.</td> </tr> <tr valign='middle'> <td align='left'>BUFFER_LENGTH</td> <td align='left'> Maximum number of bytes necessary to store data from this column. </td> </tr> <tr valign='middle'> <td align='left'>DECIMAL_DIGITS</td> <td align='left'> The scale of the column, or <b><tt class='constant'>NULL</tt></b> where scale is not applicable. </td> </tr> <tr valign='middle'> <td align='left'>NUM_PREC_RADIX</td> <td align='left'> An integer value of either <i>10</i> (representing an exact numeric data type), <i>2</i> (representing an approximate numeric data type), or <b><tt class='constant'>NULL</tt></b> (representing a data type for which radix is not applicable). </td> </tr> <tr valign='middle'> <td align='left'>NULLABLE</td> <td align='left'>An integer value representing whether the column is nullable or not.</td> </tr> <tr valign='middle'> <td align='left'>REMARKS</td> <td align='left'>Description of the column.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_DEF</td> <td align='left'>Default value for the column.</td> </tr> <tr valign='middle'> <td align='left'>SQL_DATA_TYPE</td> <td align='left'>An integer value representing the size of the column.</td> </tr> <tr valign='middle'> <td align='left'>SQL_DATETIME_SUB</td> <td align='left'> Returns an integer value representing a datetime subtype code, or <b><tt class='constant'>NULL</tt></b> for SQL data types to which this does not apply. </td> </tr> <tr valign='middle'> <td align='left'>CHAR_OCTET_LENGTH</td> <td align='left'> Maximum length in octets for a character data type column, which matches COLUMN_SIZE for single-byte character set data, or <b><tt class='constant'>NULL</tt></b> for non-character data types. </td> </tr> <tr valign='middle'> <td align='left'>ORDINAL_POSITION</td> <td align='left'>The 1-indexed position of the column in the table.</td> </tr> <tr valign='middle'> <td align='left'>IS_NULLABLE</td> <td align='left'> A string value where &amp;#039;YES&amp;#039; means that the column is nullable and &amp;#039;NO&amp;#039; means that the column is not nullable. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-columns.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-column-privileges.php' class='function' rel='rdfs-seeAlso'>db2_column_privileges()</a> - Returns a result set listing the columns and associated privileges for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_column_privileges" value="<div id='function.db2-column-privileges' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-column-privileges.php'>db2_column_privileges</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_column_privileges</span> &amp;mdash; <span class='dc-title'> Returns a result set listing the columns and associated privileges for a table </span></p> </div> <a name='function.db2-column-privileges.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>resource</span> <span class='methodname'><b>db2_column_privileges</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$qualifier</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$schema</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$table-name</tt></span> [, <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$column-name</tt></span> ]]]] )</div> <p class='para rdfs-comment'> Returns a result set listing the columns and associated privileges for a table. </p> </div> <a name='function.db2-column-privileges.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid connection to an IBM DB2, Cloudscape, or Apache Derby database. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>qualifier</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>schema</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The schema which contains the tables. To match all schemas, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>table-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the table or view. To match all tables in the database, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>column-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> The name of the column. To match all columns in the table, pass <b><tt class='constant'>NULL</tt></b> or an empty string. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-column-privileges.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns a statement resource with a result set containing rows describing the column privileges for columns matching the specified parameters. The rows are composed of the following columns: </p><table class='doctable informaltable'> <thead valign='middle'> <tr valign='middle'> <th>Column name</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>TABLE_CAT</td> <td align='left'>Name of the catalog. The value is NULL if this table does not have catalogs.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_SCHEM</td> <td align='left'>Name of the schema.</td> </tr> <tr valign='middle'> <td align='left'>TABLE_NAME</td> <td align='left'>Name of the table or view.</td> </tr> <tr valign='middle'> <td align='left'>COLUMN_NAME</td> <td align='left'>Name of the column.</td> </tr> <tr valign='middle'> <td align='left'>GRANTOR</td> <td align='left'>Authorization ID of the user who granted the privilege.</td> </tr> <tr valign='middle'> <td align='left'>GRANTEE</td> <td align='left'>Authorization ID of the user to whom the privilege was granted.</td> </tr> <tr valign='middle'> <td align='left'>PRIVILEGE</td> <td align='left'>The privilege for the column.</td> </tr> <tr valign='middle'> <td align='left'>IS_GRANTABLE</td> <td align='left'>Whether the GRANTEE is permitted to grant this privilege to other users.</td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-column-privileges.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-columns.php' class='function' rel='rdfs-seeAlso'>db2_columns()</a> - Returns a result set listing the columns and associated metadata for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-foreign-keys.php' class='function' rel='rdfs-seeAlso'>db2_foreign_keys()</a> - Returns a result set listing the foreign keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-primary-keys.php' class='function' rel='rdfs-seeAlso'>db2_primary_keys()</a> - Returns a result set listing primary keys for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedure-columns.php' class='function' rel='rdfs-seeAlso'>db2_procedure_columns()</a> - Returns a result set listing stored procedure parameters</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-procedures.php' class='function' rel='rdfs-seeAlso'>db2_procedures()</a> - Returns a result set listing the stored procedures registered in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-special-columns.php' class='function' rel='rdfs-seeAlso'>db2_special_columns()</a> - Returns a result set listing the unique row identifier columns for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-statistics.php' class='function' rel='rdfs-seeAlso'>db2_statistics()</a> - Returns a result set listing the index and statistics for a table</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-table-privileges.php' class='function' rel='rdfs-seeAlso'>db2_table_privileges()</a> - Returns a result set listing the tables and associated privileges in a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-tables.php' class='function' rel='rdfs-seeAlso'>db2_tables()</a> - Returns a result set listing the tables and associated metadata in a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_close" value="<div id='function.db2-close' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-close.php'>db2_close</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_close</span> &amp;mdash; <span class='dc-title'> Closes a database connection </span></p> </div> <a name='function.db2-close.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_close</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> This function closes a DB2 client connection created with <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> and returns the corresponding resources to the database server. </p> <p class='para'> If you attempt to close a persistent DB2 client connection created with <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>, the close request is ignored and the persistent DB2 client connection remains available for the next caller. </p> </div> <a name='function.db2-close.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies an active DB2 client connection. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-close.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-close.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Closing a connection</b></p> <div class='example-contents para'><p> The following example demonstrates a successful attempt to close a connection to an IBM DB2, Cloudscape, or Apache Derby database. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$rc</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Connection&amp;nbsp;was&amp;nbsp;successfully&amp;nbsp;closed.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Connection was successfully closed. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-close.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pclose.php' class='function' rel='rdfs-seeAlso'>db2_pclose()</a> - Closes a persistent database connection</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_client_info" value="<div id='function.db2-client-info' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-client-info.php'>db2_client_info</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.1.1)</p><p class='refpurpose'><span class='refname'>db2_client_info</span> &amp;mdash; <span class='dc-title'>Returns an object with properties that describe the DB2 database client</span></p> </div> <a name='function.db2-client-info.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>object</span> <span class='methodname'><b>db2_client_info</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> )</div> <p class='para rdfs-comment'> This function returns an object with read-only properties that return information about the DB2 database client. The following table lists the DB2 client properties: </p><table class='doctable table'> <caption><b>DB2 client properties</b></caption> <thead valign='middle'> <tr valign='middle'> <th>Property name</th> <th>Return type</th> <th>Description</th> </tr> </thead> <tbody valign='middle' class='tbody'> <tr valign='middle'> <td align='left'>APPL_CODEPAGE</td> <td align='left'>int</td> <td align='left'>The application code page.</td> </tr> <tr valign='middle'> <td align='left'>CONN_CODEPAGE</td> <td align='left'>int</td> <td align='left'>The code page for the current connection.</td> </tr> <tr valign='middle'> <td align='left'>DATA_SOURCE_NAME</td> <td align='left'>string</td> <td align='left'>The data source name (DSN) used to create the current connection to the database.</td> </tr> <tr valign='middle'> <td align='left'>DRIVER_NAME</td> <td align='left'>string</td> <td align='left'>The name of the library that implements the DB2 Call Level Interface (CLI) specification.</td> </tr> <tr valign='middle'> <td align='left'>DRIVER_ODBC_VER</td> <td align='left'>string</td> <td align='left'>The version of ODBC that the DB2 client supports. This returns a string &amp;quot;MM.mm&amp;quot; where <var class='varname'>MM</var> is the major version and <var class='varname'>mm</var> is the minor version. The DB2 client always returns &amp;quot;03.51&amp;quot;. </td> </tr> <tr valign='middle'> <td align='left'>DRIVER_VER</td> <td align='left'>string</td> <td align='left'>The version of the client, in the form of a string &amp;quot;MM.mm.uuuu&amp;quot; where <var class='varname'>MM</var> is the major version, <var class='varname'>mm</var> is the minor version, and <var class='varname'>uuuu</var> is the update. For example, &amp;quot;08.02.0001&amp;quot; represents major version 8, minor version 2, update 1. </td> </tr> <tr valign='middle'> <td align='left'>ODBC_SQL_CONFORMANCE</td> <td align='left'>string</td> <td align='left'> <p class='para'>The level of ODBC SQL grammar supported by the client: </p><dl> <dt class='varlistentry'> <span class='term'>MINIMUM</span> </dt><dd class='listitem'> <p class='para'> Supports the minimum ODBC SQL grammar. </p> </dd> <dt class='varlistentry'> <span class='term'>CORE</span> </dt><dd class='listitem'> <p class='para'> Supports the core ODBC SQL grammar. </p> </dd> <dt class='varlistentry'> <span class='term'>EXTENDED</span> </dt><dd class='listitem'> <p class='para'> Supports extended ODBC SQL grammar. </p> </dd> </dl> <p> </p> </td> </tr> <tr valign='middle'> <td align='left'>ODBC_VER</td> <td align='left'>string</td> <td align='left'>The version of ODBC that the ODBC driver manager supports. This returns a string &amp;quot;MM.mm.rrrr&amp;quot; where <var class='varname'>MM</var> is the major version, <var class='varname'>mm</var> is the minor version, and <var class='varname'>rrrr</var> is the release. The DB2 client always returns &amp;quot;03.01.0000&amp;quot;. </td> </tr> </tbody> </table> <p> </p> </div> <a name='function.db2-client-info.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies an active DB2 client connection. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-client-info.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns an object on a successful call. Returns <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-client-info.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 A <b>db2_client_info()</b> example</b></p> <div class='example-contents para'><p> To retrieve information about the client, you must pass a valid database connection resource to <b>db2_client_info()</b>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #DD0000'>'SAMPLE'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'db2inst1'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'ibmdb2'&amp;nbsp;</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$client&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_client_info</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>);<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER_NAME:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DRIVER_NAME&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER_VER:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DRIVER_VER&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DATA_SOURCE_NAME:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DATA_SOURCE_NAME&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'DRIVER_ODBC_VER:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>DRIVER_ODBC_VER&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'ODBC_VER:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ODBC_VER&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'ODBC_SQL_CONFORMANCE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>ODBC_SQL_CONFORMANCE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'APPL_CODEPAGE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>APPL_CODEPAGE&amp;nbsp;</span><span style='color: #007700'>);<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'CONN_CODEPAGE:&amp;nbsp;'</span><span style='color: #007700'>;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;</span><span style='color: #0000BB'>var_dump</span><span style='color: #007700'>(&amp;nbsp;</span><span style='color: #0000BB'>$client</span><span style='color: #007700'>-&amp;gt;</span><span style='color: #0000BB'>CONN_CODEPAGE&amp;nbsp;</span><span style='color: #007700'>);<br />}<br />else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;echo&amp;nbsp;</span><span style='color: #DD0000'>'Error&amp;nbsp;retrieving&amp;nbsp;client&amp;nbsp;information.<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;Perhaps&amp;nbsp;your&amp;nbsp;database&amp;nbsp;connection&amp;nbsp;was&amp;nbsp;invalid.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>db2_close</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> DRIVER_NAME: string(8) &amp;quot;libdb2.a&amp;quot; DRIVER_VER: string(10) &amp;quot;08.02.0001&amp;quot; DATA_SOURCE_NAME: string(6) &amp;quot;SAMPLE&amp;quot; DRIVER_ODBC_VER: string(5) &amp;quot;03.51&amp;quot; ODBC_VER: string(10) &amp;quot;03.01.0000&amp;quot; ODBC_SQL_CONFORMANCE: string(8) &amp;quot;EXTENDED&amp;quot; APPL_CODEPAGE: int(819) CONN_CODEPAGE: int(819) </pre></div> </div> </div><p> </p> </div> <a name='function.db2-client-info.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-server-info.php' class='function' rel='rdfs-seeAlso'>db2_server_info()</a> - Returns an object with properties that describe the DB2 database server</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_bind_param" value="<div id='function.db2-bind-param' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-bind-param.php'>db2_bind_param</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_bind_param</span> &amp;mdash; <span class='dc-title'> Binds a PHP variable to an SQL statement parameter </span></p> </div> <a name='function.db2-bind-param.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'>bool</span> <span class='methodname'><b>db2_bind_param</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$stmt</tt></span> , <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$parameter-number</tt></span> , <span class='methodparam'><span class='type'>string</span> <tt class='parameter'>$variable-name</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$parameter-type</tt></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$data-type</tt><span class='initializer'> = 0</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$precision</tt><span class='initializer'> = -1</span></span> [, <span class='methodparam'><span class='type'>int</span> <tt class='parameter'>$scale</tt><span class='initializer'> = 0</span></span> ]]]] )</div> <p class='para rdfs-comment'> Binds a PHP variable to an SQL statement parameter in a statement resource returned by <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a>. This function gives you more control over the parameter type, data type, precision, and scale for the parameter than simply passing the variable as part of the optional input array to <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a>. </p> </div> <a name='function.db2-bind-param.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'>stmt</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A prepared statement returned from <a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function'>db2_prepare()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>parameter-number</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the 1-indexed position of the parameter in the prepared statement. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>variable-name</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A string specifying the name of the PHP variable to bind to the parameter specified by <i><tt class='parameter'>parameter-number</tt></i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>parameter-type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A constant specifying whether the PHP variable should be bound to the SQL parameter as an input parameter (<i>DB2_PARAM_IN</i>), an output parameter (<i>DB2_PARAM_OUT</i>), or as a parameter that accepts input and returns output (<i>DB2_PARAM_INOUT</i>). To avoid memory overhead, you can also specify <i>DB2_PARAM_FILE</i> to bind the PHP variable to the name of a file that contains large object (BLOB, CLOB, or DBCLOB) data. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>data-type</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A constant specifying the SQL data type that the PHP variable should be bound as: one of <i>DB2_BINARY</i>, <i>DB2_CHAR</i>, <i>DB2_DOUBLE</i>, or <i>DB2_LONG</i> . </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>precision</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the precision with which the variable should be bound to the database. This parameter can also be used for retrieving XML output values from stored procedures. A non-negative value specifies the maximum size of the XML data that will be retrieved from the database. If this parameter is not used, a default of 1MB will be assumed for retrieving the XML output value from the stored procedure. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>scale</tt></i> </span> </dt><dd class='listitem'> <p class='para'> Specifies the scale with which the variable should be bound to the database. </p> </dd> </dl> <p> </p> </div> <a name='function.db2-bind-param.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-bind-param.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Binding PHP variables to a prepared statement</b></p> <div class='example-contents para'><p> The SQL statement in the following example uses two input parameters in the WHERE clause. We call <b>db2_bind_param()</b> to bind two PHP variables to the corresponding SQL parameters. Notice that the PHP variables do not have to be declared or assigned before the call to <b>db2_bind_param()</b>; in the example, <i>$lower_limit</i> is assigned a value before the call to <b>db2_bind_param()</b>, but <i>$upper_limit</i> is assigned a value after the call to <b>db2_bind_param()</b>. The variables must be bound and, for parameters that accept input, must have any value assigned, before calling <a href='http://www.php.net/manual/en/function.db2-execute.php' class='function'>db2_execute()</a>. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'SELECT&amp;nbsp;name,&amp;nbsp;breed,&amp;nbsp;weight&amp;nbsp;FROM&amp;nbsp;animals<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;WHERE&amp;nbsp;weight&amp;nbsp;&amp;gt;&amp;nbsp;?&amp;nbsp;AND&amp;nbsp;weight&amp;nbsp;&amp;lt;&amp;nbsp;?'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;We&amp;nbsp;can&amp;nbsp;declare&amp;nbsp;the&amp;nbsp;variable&amp;nbsp;before&amp;nbsp;calling&amp;nbsp;db2_bind_param()<br /></span><span style='color: #0000BB'>$lower_limit&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'lower_limit'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'upper_limit'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;We&amp;nbsp;can&amp;nbsp;also&amp;nbsp;declare&amp;nbsp;the&amp;nbsp;variable&amp;nbsp;after&amp;nbsp;calling&amp;nbsp;db2_bind_param()<br /></span><span style='color: #0000BB'>$upper_limit&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>15.0</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Pook, cat, 3.2 Rickety Ride, goat, 9.7 Peaches, dog, 12.3 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Calling stored procedures with IN and OUT parameters</b></p> <div class='example-contents para'><p> The stored procedure match_animal in the following example accepts three different parameters: </p><ol type='1'> <li class='listitem'> <p class='para'> an input (IN) parameter that accepts the name of the first animal as input </p> </li> <li class='listitem'> <p class='para'> an input-output (INOUT) parameter that accepts the name of the second animal as input and returns the string <i>TRUE</i> if an animal in the database matches that name </p> </li> <li class='listitem'> <p class='para'> an output (OUT) parameter that returns the sum of the weight of the two identified animals </p> </li> </ol><p> In addition, the stored procedure returns a result set consisting of the animals listed in alphabetic order starting at the animal corresponding to the input value of the first parameter and ending at the animal corresponding to the input value of the second parameter. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br /><br />$sql&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'CALL&amp;nbsp;match_animal(?,&amp;nbsp;?,&amp;nbsp;?)'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$sql</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Peaches'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$second_name&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'Rickety&amp;nbsp;Ride'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$weight&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>;<br /><br /></span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'name'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_IN</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>2</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'second_name'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_INOUT</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>3</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'weight'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_OUT</span><span style='color: #007700'>);<br /><br />print&amp;nbsp;</span><span style='color: #DD0000'>'Values&amp;nbsp;of&amp;nbsp;bound&amp;nbsp;parameters&amp;nbsp;_before_&amp;nbsp;CALL:\n'</span><span style='color: #007700'>;<br />print&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;1:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;2:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$second_name</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;3:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$weight</span><span style='color: #007700'>}</span><span style='color: #DD0000'>\n\n'</span><span style='color: #007700'>;<br /><br />if&amp;nbsp;(</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Values&amp;nbsp;of&amp;nbsp;bound&amp;nbsp;parameters&amp;nbsp;_after_&amp;nbsp;CALL:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;1:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$name</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;2:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$second_name</span><span style='color: #007700'>}</span><span style='color: #DD0000'>&amp;nbsp;3:&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$weight</span><span style='color: #007700'>}</span><span style='color: #DD0000'>\n\n'</span><span style='color: #007700'>;<br /><br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Results:\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;while&amp;nbsp;(</span><span style='color: #0000BB'>$row&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_fetch_array</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>))&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'&amp;nbsp;&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>0</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>1</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>,&amp;nbsp;</span><span style='color: #007700'>{</span><span style='color: #0000BB'>$row</span><span style='color: #007700'>[</span><span style='color: #0000BB'>2</span><span style='color: #007700'>]}</span><span style='color: #DD0000'>\n'</span><span style='color: #007700'>;<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;}<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Values of bound parameters _before_ CALL: 1: Peaches 2: Rickety Ride 3: 0 Values of bound parameters _after_ CALL: 1: Peaches 2: TRUE 3: 22 Results: Peaches, dog, 12.3 Pook, cat, 3.2 Rickety Ride, goat, 9.7 </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #3 Inserting a binary large object (BLOB) directly from a file</b></p> <div class='example-contents para'><p> The data for large objects are typically stored in files, such as XML documents or audio files. Rather than reading an entire file into a PHP variable, and then binding that PHP variable into an SQL statement, you can avoid some memory overhead by binding the file directly to the input parameter of your SQL statement. The following example demonstrates how to bind a file directly into a BLOB column. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$stmt&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_prepare</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'INSERT&amp;nbsp;INTO&amp;nbsp;animal_pictures(picture)&amp;nbsp;VALUES&amp;nbsp;(?)'</span><span style='color: #007700'>);<br /><br /></span><span style='color: #0000BB'>$picture&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #DD0000'>'/opt/albums/spook/grooming.jpg'</span><span style='color: #007700'>;<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_bind_param</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>1</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #DD0000'>'picture'</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_PARAM_FILE</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_execute</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$stmt</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> </div><p> </p> </div> <a name='function.db2-bind-param.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-execute.php' class='function' rel='rdfs-seeAlso'>db2_execute()</a> - Executes a prepared SQL statement</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-prepare.php' class='function' rel='rdfs-seeAlso'>db2_prepare()</a> - Prepares an SQL statement to be executed</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
<string id="db2_autocommit" value="<div id='function.db2-autocommit' class='refentry'> <div class='refnamediv'> <h1 class='refname'><a class='info-url' href='http://www.php.net/manual/en/function.db2-autocommit.php'>db2_autocommit</a></h1> <p class='verinfo'>(PECL ibm_db2 &amp;gt;= 1.0.0)</p><p class='refpurpose'><span class='refname'>db2_autocommit</span> &amp;mdash; <span class='dc-title'> Returns or sets the AUTOCOMMIT state for a database connection </span></p> </div> <a name='function.db2-autocommit.description'></a><div class='refsect1 description'> <h3 class='title'>Description</h3> <div class='methodsynopsis dc-description'> <span class='type'><a href='http://www.php.net/manual/en/language.pseudo-types.php#language.types.mixed' class='type mixed'>mixed</a></span> <span class='methodname'><b>db2_autocommit</b></span> ( <span class='methodparam'><span class='type'>resource</span> <tt class='parameter'>$connection</tt></span> [, <span class='methodparam'><span class='type'>bool</span> <tt class='parameter'>$value</tt></span> ] )</div> <p class='para rdfs-comment'> Sets or gets the AUTOCOMMIT behavior of the specified connection resource. </p> </div> <a name='function.db2-autocommit.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'>connection</tt></i> </span> </dt><dd class='listitem'> <p class='para'> A valid database connection resource variable as returned from <a href='http://www.php.net/manual/en/function.db2-connect.php' class='function'>db2_connect()</a> or <a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function'>db2_pconnect()</a>. </p> </dd> <dt class='varlistentry'> <span class='term'><i><tt class='parameter'>value</tt></i> </span> </dt><dd class='listitem'> <p class='para'> One of the following constants: </p><dl> <dt class='varlistentry'> <br /><span class='term'><i>DB2_AUTOCOMMIT_OFF</i></span> </dt><dd class='listitem'> <p class='para'> Turns AUTOCOMMIT off. </p> </dd> <dt class='varlistentry'> <span class='term'><i>DB2_AUTOCOMMIT_ON</i></span> </dt><dd class='listitem'> <p class='para'> Turns AUTOCOMMIT on. </p> </dd> </dl> <p> </p> </dd> </dl> <p> </p> </div> <a name='function.db2-autocommit.returnvalues'></a><div class='refsect1 returnvalues'> <h3 class='title'>Return Values</h3> <p class='para'> When <b>db2_autocommit()</b> receives only the <i><tt class='parameter'>connection</tt></i> parameter, it returns the current state of AUTOCOMMIT for the requested connection as an integer value. A value of 0 indicates that AUTOCOMMIT is off, while a value of 1 indicates that AUTOCOMMIT is on. </p> <p class='para'> When <b>db2_autocommit()</b> receives both the <i><tt class='parameter'>connection</tt></i> parameter and <i><tt class='parameter'>autocommit</tt></i> parameter, it attempts to set the AUTOCOMMIT state of the requested connection to the corresponding state. Returns <b><tt class='constant'>TRUE</tt></b> on success or <b><tt class='constant'>FALSE</tt></b> on failure. </p> </div> <a name='function.db2-autocommit.examples'></a><div class='refsect1 examples'> <h3 class='title'>Examples</h3> <p class='para'> </p><div class='example'> <p><b>Example #1 Retrieving the AUTOCOMMIT value for a connection</b></p> <div class='example-contents para'><p> In the following example, a connection which has been created with AUTOCOMMIT turned off is tested with the <b>db2_autocommit()</b> function. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$ac&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ac&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$ac</span><span style='color: #DD0000'>&amp;nbsp;--&amp;nbsp;AUTOCOMMIT&amp;nbsp;is&amp;nbsp;off.'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$ac</span><span style='color: #DD0000'>&amp;nbsp;--&amp;nbsp;AUTOCOMMIT&amp;nbsp;is&amp;nbsp;on.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> 0 -- AUTOCOMMIT is off. </pre></div> </div> </div><p> </p><div class='example'> <p><b>Example #2 Setting the AUTOCOMMIT value for a connection</b></p> <div class='example-contents para'><p> In the following example, a connection which was initially created with AUTOCOMMIT turned off has its behavior changed to turn AUTOCOMMIT on. </p></div> <div class='example-contents programlisting'> <div class='phpcode'><code><span style='color: #000000'> <span style='color: #0000BB'>&amp;lt;?php<br />$options&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;array(</span><span style='color: #DD0000'>'autocommit'&amp;nbsp;</span><span style='color: #007700'>=&amp;gt;&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_OFF</span><span style='color: #007700'>);<br /></span><span style='color: #0000BB'>$conn&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_connect</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$database</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$user</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$password</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>$options</span><span style='color: #007700'>);<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Turn&amp;nbsp;AUTOCOMMIT&amp;nbsp;on<br /></span><span style='color: #0000BB'>$rc&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>,&amp;nbsp;</span><span style='color: #0000BB'>DB2_AUTOCOMMIT_ON</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$rc</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'Turning&amp;nbsp;AUTOCOMMIT&amp;nbsp;on&amp;nbsp;succeeded.\n'</span><span style='color: #007700'>;<br />}<br /><br /></span><span style='color: #FF8000'>//&amp;nbsp;Check&amp;nbsp;AUTOCOMMIT&amp;nbsp;state<br /></span><span style='color: #0000BB'>$ac&amp;nbsp;</span><span style='color: #007700'>=&amp;nbsp;</span><span style='color: #0000BB'>db2_autocommit</span><span style='color: #007700'>(</span><span style='color: #0000BB'>$conn</span><span style='color: #007700'>);<br />if&amp;nbsp;(</span><span style='color: #0000BB'>$ac&amp;nbsp;</span><span style='color: #007700'>==&amp;nbsp;</span><span style='color: #0000BB'>0</span><span style='color: #007700'>)&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$ac</span><span style='color: #DD0000'>&amp;nbsp;--&amp;nbsp;AUTOCOMMIT&amp;nbsp;is&amp;nbsp;off.'</span><span style='color: #007700'>;<br />}&amp;nbsp;else&amp;nbsp;{<br />&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;print&amp;nbsp;</span><span style='color: #DD0000'>'</span><span style='color: #0000BB'>$ac</span><span style='color: #DD0000'>&amp;nbsp;--&amp;nbsp;AUTOCOMMIT&amp;nbsp;is&amp;nbsp;on.'</span><span style='color: #007700'>;<br />}<br /></span><span style='color: #0000BB'>?&amp;gt;</span> </span> </code></div> </div> <div class='example-contents para'><p>The above example will output:</p></div> <div class='example-contents screen'> <div class='cdata'><pre> Turning AUTOCOMMIT on succeeded. 1 -- AUTOCOMMIT is on. </pre></div> </div> </div><p> </p> </div> <a name='function.db2-autocommit.seealso'></a><div class='refsect1 seealso'> <h3 class='title'>See Also</h3> <p class='para'> </p><ul class='simplelist'> <li class='member'><a href='http://www.php.net/manual/en/function.db2-connect.php' class='function' rel='rdfs-seeAlso'>db2_connect()</a> - Returns a connection to a database</li> <li class='member'><a href='http://www.php.net/manual/en/function.db2-pconnect.php' class='function' rel='rdfs-seeAlso'>db2_pconnect()</a> - Returns a persistent connection to a database</li> </ul><p> </p> </div> </div><div class='copyright-info'>PHP Documentation is licensed under the <a class='copyright-url' href='http://creativecommons.org/licenses/by/3.0/legalcode'>Creative Commons  Attribution 3.0 License</a>. &copy; 2001-2009 the PHP  Documentation Group.</div> " />
</strings>

