cvs: phpdoc /en/reference/msql/functions msql-affected-rows.xml msql-close.xml msql-connect.xml msql-create-db.xml msql-createdb.xml
msql-data-seek.xml msql-db-query.xml msql-dbname.xml msql-drop-db.xml msql-error.xml msql-fetch-array.xml msql-fetch-field.xml msql-fetch-object.xml
msql-fetch-row.xml msql-field-flags.xml msql-field-len.xml msql-field-name.xml msql-field-seek.xml msql-field-table.xml msql-field-type.xml
msql-fieldflags.xml msql-fieldlen.xml msql-fieldname.xml msql-fieldtable.xml msql-fieldtype.xml msql-free-result.xml msql-list-dbs.xml
msql-list-fields.xml msql-list-tables.xml msql-num-fields.xml msql-num-rows.xml msql-numfields.xml msql-numrows.xml msql-pconnect.xml msql-query.xml
msql-regcase.xml msql-result.xml msql-select-db.xml msql-tablename.xml msql.xml

From:	Mehdi Achour	Date:	Sun, 03 Apr 2005 22:53:25 +0000
Subject:	cvs: phpdoc /en/reference/msql/functions msql-affected-rows.xml msql-close.xml msql-connect.xml msql-create-db.xml msql-createdb.xml msql-data-seek.xml msql-db-query.xml msql-dbname.xml msql-drop-db.xml msql-error.xml msql-fetch-array.xml msql-fetch-field.xml msql-fetch-object.xml msql-fetch-row.xml msql-field-flags.xml msql-field-len.xml msql-field-name.xml msql-field-seek.xml msql-field-table.xml msql-field-type.xml msql-fieldflags.xml msql-fieldlen.xml msql-fieldname.xml msql-fieldtable.xml msql-fieldtype.xml msql-free-result.xml msql-list-dbs.xml msql-list-fields.xml msql-list-tables.xml msql-num-fields.xml msql-num-rows.xml msql-numfields.xml msql-numrows.xml msql-pconnect.xml msql-query.xml msql-regcase.xml msql-result.xml msql-select-db.xml msql-tablename.xml msql.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969367374@lists.php.net to get a copy of this message

didou Sun Apr 3 18:53:25 2005 EDT Modified files: /phpdoc/en/reference/msql/functions msql-affected-rows.xml msql-close.xml msql-connect.xml msql-create-db.xml msql-createdb.xml msql-data-seek.xml msql-db-query.xml msql-dbname.xml msql-drop-db.xml msql-error.xml msql-fetch-array.xml msql-fetch-field.xml msql-fetch-object.xml msql-fetch-row.xml msql-field-flags.xml msql-field-len.xml msql-field-name.xml msql-field-seek.xml msql-field-table.xml msql-field-type.xml msql-fieldflags.xml msql-fieldlen.xml msql-fieldname.xml msql-fieldtable.xml msql-fieldtype.xml msql-free-result.xml msql-list-dbs.xml msql-list-fields.xml msql-list-tables.xml msql-num-fields.xml msql-num-rows.xml msql-numfields.xml msql-numrows.xml msql-pconnect.xml msql-query.xml msql-regcase.xml msql-result.xml msql-select-db.xml msql-tablename.xml msql.xml Log: WS fix, preparing for new doc style

http://cvs.php.net/diff.php/phpdoc/en/reference/msql/functions/msql-affected-rows.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/msql/functions/msql-affected-rows.xml diff -u phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.3 phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.4 --- phpdoc/en/reference/msql/functions/msql-affected-rows.xml:1.3 Tue Mar 2 05:16:05 2004 +++ phpdoc/en/reference/msql/functions/msql-affected-rows.xml Sun Apr 3 18:53:22 2005 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - - <refentry id="function.msql-affected-rows"> - <refnamediv> - <refname>msql_affected_rows</refname> - <refpurpose>Returns number of affected rows</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_affected_rows</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - </methodsynopsis> - <para> - Returns number of affected ("touched") rows by a specific query - (i.e. the number of rows returned by a SELECT, the number of rows - modified by an update, or the number of rows removed by a - delete). - </para> - <para> - See also: <function>msql_query</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-affected-rows"> + <refnamediv> + <refname>msql_affected_rows</refname> + <refpurpose>Returns number of affected rows</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_affected_rows</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> + <para> + Returns number of affected ("touched") rows by a specific query + (i.e. the number of rows returned by a SELECT, the number of rows + modified by an update, or the number of rows removed by a + delete). + </para> + <para> + See also: <function>msql_query</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-close"> - <refnamediv> - <refname>msql_close</refname> - <refpurpose>Close mSQL connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_close</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_close</function> closes the link to a mSQL - database that's associated with the specified link identifier. - If the link identifier isn't specified, the last opened link is - assumed. - </para> - <para> - &return.success; - </para> - <para> - Note that this isn't usually necessary, as non-persistent open - links are automatically closed at the end of the script's - execution. - </para> - <para> - <function>msql_close</function> will not close persistent links - generated by <function>msql_pconnect</function>. - </para> - <para> - See also: - <function>msql_connect</function> and - <function>msql_pconnect</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-close"> + <refnamediv> + <refname>msql_close</refname> + <refpurpose>Close mSQL connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_close</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_close</function> closes the link to a mSQL + database that's associated with the specified link identifier. + If the link identifier isn't specified, the last opened link is + assumed. + </para> + <para> + &return.success; + </para> + <para> + Note that this isn't usually necessary, as non-persistent open + links are automatically closed at the end of the script's + execution. + </para> + <para> + <function>msql_close</function> will not close persistent links + generated by <function>msql_pconnect</function>. + </para> + <para> + See also: + <function>msql_connect</function> and + <function>msql_pconnect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-connect"> - <refnamediv> - <refname>msql_connect</refname> - <refpurpose>Open mSQL connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_connect</methodname> - <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_connect</function> establishes a connection to a - mSQL server. The <parameter>hostname</parameter> parameter can also - include a port number. e.g. "hostname:port". - If the hostname is not specified, the connection is established by the - means of a Unix domain socket, being then more efficient then a localhost - TCP socket connection. - </para> - <note> - <simpara> - While this function will accept a colon (":") as a - host/port separator, a comma (",") is the preferred method. - </simpara> - </note> - <para> - Returns a positive mSQL link identifier on success, or &false; on - error. - </para> - <para> - In case a second call is made to - <function>msql_connect</function> with the same arguments, no new - link will be established, but instead, the link identifier of the - already opened link will be returned. - </para> - <para> - The link to the server will be closed as soon as the execution of - the script ends, unless it's closed earlier by explicitly calling - <function>msql_close</function>. - </para> - <para> - See also - <function>msql_pconnect</function> and - <function>msql_close</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-connect"> + <refnamediv> + <refname>msql_connect</refname> + <refpurpose>Open mSQL connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>hostname</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_connect</function> establishes a connection to a + mSQL server. The <parameter>hostname</parameter> parameter can also + include a port number. e.g. "hostname:port". + If the hostname is not specified, the connection is established by the + means of a Unix domain socket, being then more efficient then a localhost + TCP socket connection. + </para> + <note> + <simpara> + While this function will accept a colon (":") as a + host/port separator, a comma (",") is the preferred method. + </simpara> + </note> + <para> + Returns a positive mSQL link identifier on success, or &false; on + error. + </para> + <para> + In case a second call is made to + <function>msql_connect</function> with the same arguments, no new + link will be established, but instead, the link identifier of the + already opened link will be returned. + </para> + <para> + The link to the server will be closed as soon as the execution of + the script ends, unless it's closed earlier by explicitly calling + <function>msql_close</function>. + </para> + <para> + See also + <function>msql_pconnect</function> and + <function>msql_close</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-create-db"> - <refnamediv> - <refname>msql_create_db</refname> - <refpurpose>Create mSQL database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msql_create_db</methodname> - <methodparam><type>string</type><parameter>database_name</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_create_db</function> attempts to create a new database on the server - associated with the specified <parameter>link_identifier</parameter>. - </para> - <para> - &return.success; - </para> - <para> - See also - <function>msql_drop_db</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-create-db"> + <refnamediv> + <refname>msql_create_db</refname> + <refpurpose>Create mSQL database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msql_create_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_create_db</function> attempts to create a new database on the server + associated with the specified <parameter>link_identifier</parameter>. + </para> + <para> + &return.success; + </para> + <para> + See also + <function>msql_drop_db</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-createdb"> - <refnamediv> - <refname>msql_createdb</refname> - <refpurpose>Alias of <function>msql_create_db</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_create_db</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-createdb"> + <refnamediv> + <refname>msql_createdb</refname> + <refpurpose>Alias of <function>msql_create_db</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_create_db</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-data-seek"> - <refnamediv> - <refname>msql_data_seek</refname> - <refpurpose>Move internal row pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msql_data_seek</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>row_number</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_data_seek</function> moves the internal row - pointer of the mSQL result associated with the specified query - identifier to point to the specified row number. The next call - to <function>msql_fetch_row</function> would return that - row. - </para> - <para> - &return.success; - </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_fetch_row</function> and - <function>msql_result</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-data-seek"> + <refnamediv> + <refname>msql_data_seek</refname> + <refpurpose>Move internal row pointer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msql_data_seek</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_data_seek</function> moves the internal row + pointer of the mSQL result associated with the specified query + identifier to point to the specified row number. The next call + to <function>msql_fetch_row</function> would return that + row. + </para> + <para> + &return.success; + </para> + <para> + See also + <function>msql_fetch_array</function>, + <function>msql_fetch_object</function>, + <function>msql_fetch_row</function> and + <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-db-query"> - <refnamediv> - <refname>msql_db_query</refname> - <refpurpose>Send mSQL query</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msql_db_query</methodname> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - Returns a positive mSQL query identifier to the query result, or - &false; on error. - </para> - <para> - <function>msql_db_query</function> selects a database and executes a query - on it. If the optional <parameter>link_identifier</parameter> - is not specified, the function will try to find an open link to the mSQL - server; if no such link is found it will try to create one as if - <function>msql_connect</function> was called with no arguments. - </para> - <para> - See also <function>msql_connect</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-db-query"> + <refnamediv> + <refname>msql_db_query</refname> + <refpurpose>Send mSQL query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msql_db_query</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + Returns a positive mSQL query identifier to the query result, or + &false; on error. + </para> + <para> + <function>msql_db_query</function> selects a database and executes a query + on it. If the optional <parameter>link_identifier</parameter> + is not specified, the function will try to find an open link to the mSQL + server; if no such link is found it will try to create one as if + <function>msql_connect</function> was called with no arguments. + </para> + <para> + See also <function>msql_connect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-dbname"> - <refnamediv> - <refname>msql_dbname</refname> - <refpurpose>Alias of <function>msql_result</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_result</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-dbname"> + <refnamediv> + <refname>msql_dbname</refname> + <refpurpose>Alias of <function>msql_result</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-drop-db"> - <refnamediv> - <refname>msql_drop_db</refname> - <refpurpose>Drop (delete) mSQL database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_drop_db</methodname> - <methodparam><type>string</type><parameter>database_name</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - &return.success; - </para> - <para> - <function>msql_drop_db</function> attempts to drop (remove) an - entire database from the server associated with the specified - link identifier. - </para> - <para> - See also: <function>msql_create_db</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-drop-db"> + <refnamediv> + <refname>msql_drop_db</refname> + <refpurpose>Drop (delete) mSQL database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_drop_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <para> + <function>msql_drop_db</function> attempts to drop (remove) an + entire database from the server associated with the specified + link identifier. + </para> + <para> + See also: <function>msql_create_db</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-error"> - <refnamediv> - <refname>msql_error</refname> - <refpurpose>Returns error message of last msql call</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>msql_error</methodname> - <void/> - </methodsynopsis> - <para> - <function>msql_error</function> returns the last issued error by the mSQL - server or an empty string if no error was issued. If no link is - explicitly passed, the last successful open link will be used to retrieve - the error message. Note that only the last error message is accessible - with <function>msql_error</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-error"> + <refnamediv> + <refname>msql_error</refname> + <refpurpose>Returns error message of last msql call</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>msql_error</methodname> + <void/> + </methodsynopsis> + <para> + <function>msql_error</function> returns the last issued error by the mSQL + server or an empty string if no error was issued. If no link is + explicitly passed, the last successful open link will be used to retrieve + the error message. Note that only the last error message is accessible + with <function>msql_error</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fetch-array"> - <refnamediv> - <refname>msql_fetch_array</refname> - <refpurpose>Fetch row as array</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>msql_fetch_array</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> - <function>msql_fetch_array</function> is an extended version of - <function>msql_fetch_row</function>. 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. - </para> - <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> - <para> - An important thing to note is that using - <function>msql_fetch_array</function> is NOT significantly slower - than using <function>msql_fetch_row</function>, while it provides - a significant added value. - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> - <para> - <example> - <title><function>msql_fetch_array</function> example</title> - <programlisting role="php"> + +<refentry id="function.msql-fetch-array"> + <refnamediv> + <refname>msql_fetch_array</refname> + <refpurpose>Fetch row as array</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>msql_fetch_array</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + <para> + <function>msql_fetch_array</function> is an extended version of + <function>msql_fetch_row</function>. 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. + </para> + <para> + The second optional argument <parameter>result_type</parameter> + is a constant and can take the following values: + <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and + <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being + the default. + </para> + <para> + An important thing to note is that using + <function>msql_fetch_array</function> is NOT significantly slower + than using <function>msql_fetch_row</function>, while it provides + a significant added value. + </para> + <warning> + <simpara> + In PHP versions prior to 4.3.11 and 5.0.4 a bug existed + when retrieving data from columns containing &null; values. + Such columns were not placed into the resulting array. + </simpara> + </warning> + <para> + <example> + <title><function>msql_fetch_array</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $con = msql_connect(); @@ -70,18 +69,18 @@ msql_free_result($result); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>msql_fetch_row</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>msql_fetch_row</function>, + <function>msql_fetch_object</function>, + <function>msql_data_seek</function> and + <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fetch-field"> - <refnamediv> - <refname>msql_fetch_field</refname> - <refpurpose>Get field information</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>msql_fetch_field</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - Returns an object containing field information - </para> - <para> - <function>msql_fetch_field</function> can be used in order to - obtain information about fields in a certain query result. If - the field offset isn't specified, the next field that wasn't yet - retrieved by <function>msql_fetch_field</function> is retrieved. - </para> - <para> - The properties of the object are: - <itemizedlist> - <listitem> - <simpara> - name - column name - </simpara> - </listitem> - <listitem> - <simpara> - table - name of the table the column belongs to - </simpara> - </listitem> - <listitem> - <simpara> - not_null - 1 if the column cannot be &null; - </simpara> - </listitem> - <listitem> - <simpara> - unique - 1 if the column is a unique key - </simpara> - </listitem> - <listitem> - <simpara> - type - the type of the column - </simpara> - </listitem> - </itemizedlist> - </para> - <para> - See also <function>msql_field_seek</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fetch-field"> + <refnamediv> + <refname>msql_fetch_field</refname> + <refpurpose>Get field information</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>msql_fetch_field</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + Returns an object containing field information + </para> + <para> + <function>msql_fetch_field</function> can be used in order to + obtain information about fields in a certain query result. If + the field offset isn't specified, the next field that wasn't yet + retrieved by <function>msql_fetch_field</function> is retrieved. + </para> + <para> + The properties of the object are: + <itemizedlist> + <listitem> + <simpara> + name - column name + </simpara> + </listitem> + <listitem> + <simpara> + table - name of the table the column belongs to + </simpara> + </listitem> + <listitem> + <simpara> + not_null - 1 if the column cannot be &null; + </simpara> + </listitem> + <listitem> + <simpara> + unique - 1 if the column is a unique key + </simpara> + </listitem> + <listitem> + <simpara> + type - the type of the column + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + See also <function>msql_field_seek</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fetch-object"> - <refnamediv> - <refname>msql_fetch_object</refname> - <refpurpose>Fetch row as object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>msql_fetch_object</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> - </methodsynopsis> - <para> - Returns an object with properties that correspond to the fetched - row, or &false; if there are no more rows. - </para> - <para> - <function>msql_fetch_object</function> is similar to - <function>msql_fetch_array</function>, 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). - </para> - <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being - the default. - </para> - <para> - Speed-wise, the function is identical to - <function>msql_fetch_array</function>, and almost as quick as - <function>msql_fetch_row</function> (the difference is - insignificant). - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> - <para> - <example> - <title><function>msql_fetch_object</function> example</title> - <programlisting role="php"> + +<refentry id="function.msql-fetch-object"> + <refnamediv> + <refname>msql_fetch_object</refname> + <refpurpose>Fetch row as object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>msql_fetch_object</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> + <para> + Returns an object with properties that correspond to the fetched + row, or &false; if there are no more rows. + </para> + <para> + <function>msql_fetch_object</function> is similar to + <function>msql_fetch_array</function>, 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). + </para> + <para> + The second optional argument <parameter>result_type</parameter> + is a constant and can take the following values: + <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and + <constant>MSQL_BOTH</constant> with <constant>MSQL_BOTH</constant> being + the default. + </para> + <para> + Speed-wise, the function is identical to + <function>msql_fetch_array</function>, and almost as quick as + <function>msql_fetch_row</function> (the difference is + insignificant). + </para> + <warning> + <simpara> + In PHP versions prior to 4.3.11 and 5.0.4 a bug existed + when retrieving data from columns containing &null; values. + Such columns were not placed into the resulting array. + </simpara> + </warning> + <para> + <example> + <title><function>msql_fetch_object</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $con = msql_connect(); @@ -71,18 +70,18 @@ msql_free_result($result); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_row</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>msql_fetch_array</function>, + <function>msql_fetch_row</function>, + <function>msql_data_seek</function> and + <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fetch-row"> - <refnamediv> - <refname>msql_fetch_row</refname> - <refpurpose>Get row as enumerated array</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>msql_fetch_row</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> - </methodsynopsis> - <para> - Returns an array that corresponds to the fetched row, or &false; if - there are no more rows. - </para> - <para> - <function>msql_fetch_row</function> fetches one row of data from - the result associated with the specified query identifier. The - row is returned as an array. Each result column is stored in an - array offset, starting at offset 0. - </para> - <para> - Subsequent call to <function>msql_fetch_row</function> would - return the next row in the result set, or &false; if there are no - more rows. - </para> - <para> - The second optional argument <parameter>result_type</parameter> - is a constant and can take the following values: - <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and - <constant>MSQL_BOTH</constant> with <constant>MSQL_NUM</constant> being - the default. - </para> - <warning> - <simpara> - In PHP versions prior to 4.3.11 and 5.0.4 a bug existed - when retrieving data from columns containing &null; values. - Such columns were not placed into the resulting array. - </simpara> - </warning> - <para> - <example> - <title><function>msql_fetch_row</function> example</title> - <programlisting role="php"> + +<refentry id="function.msql-fetch-row"> + <refnamediv> + <refname>msql_fetch_row</refname> + <refpurpose>Get row as enumerated array</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>msql_fetch_row</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam> + </methodsynopsis> + <para> + Returns an array that corresponds to the fetched row, or &false; if + there are no more rows. + </para> + <para> + <function>msql_fetch_row</function> fetches one row of data from + the result associated with the specified query identifier. The + row is returned as an array. Each result column is stored in an + array offset, starting at offset 0. + </para> + <para> + Subsequent call to <function>msql_fetch_row</function> would + return the next row in the result set, or &false; if there are no + more rows. + </para> + <para> + The second optional argument <parameter>result_type</parameter> + is a constant and can take the following values: + <constant>MSQL_ASSOC</constant>, <constant>MSQL_NUM</constant>, and + <constant>MSQL_BOTH</constant> with <constant>MSQL_NUM</constant> being + the default. + </para> + <warning> + <simpara> + In PHP versions prior to 4.3.11 and 5.0.4 a bug existed + when retrieving data from columns containing &null; values. + Such columns were not placed into the resulting array. + </simpara> + </warning> + <para> + <example> + <title><function>msql_fetch_row</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $con = msql_connect(); @@ -69,18 +68,18 @@ msql_free_result($result); ?> ]]> - </programlisting> - </example> - </para> - <para> - See also - <function>msql_fetch_array</function>, - <function>msql_fetch_object</function>, - <function>msql_data_seek</function> and - <function>msql_result</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>msql_fetch_array</function>, + <function>msql_fetch_object</function>, + <function>msql_data_seek</function> and + <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-field-flags"> - <refnamediv> - <refname>msql_field_flags</refname> - <refpurpose>Get field flags</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>msql_field_flags</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_field_flags</function> returns the field flags of - the specified field. Currently this is either, "not &null;", - "primary key", a combination of the two or "" (an empty string). - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-flags"> + <refnamediv> + <refname>msql_field_flags</refname> + <refpurpose>Get field flags</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>msql_field_flags</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_field_flags</function> returns the field flags of + the specified field. Currently this is either, "not &null;", + "primary key", a combination of the two or "" (an empty string). + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-field-len"> - <refnamediv> - <refname>msql_field_len</refname> - <refpurpose>Get field length</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_field_len</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_field_len</function> returns the length of the - specified field or &false; on error. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-len"> + <refnamediv> + <refname>msql_field_len</refname> + <refpurpose>Get field length</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_field_len</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_field_len</function> returns the length of the + specified field or &false; on error. + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-field-name"> - <refnamediv> - <refname>msql_field_name</refname> - <refpurpose>Get field name</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>msql_field_name</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_field_name</function> returns the name of the - specified <parameter>field</parameter> from the result resource - <parameter>query_identifier</parameter>. - <literal>msql_field_name($result, 2);</literal> will - return the name of the second field in the result set associated with - the result identifier. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-name"> + <refnamediv> + <refname>msql_field_name</refname> + <refpurpose>Get field name</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>msql_field_name</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_field_name</function> returns the name of the + specified <parameter>field</parameter> from the result resource + <parameter>query_identifier</parameter>. + <literal>msql_field_name($result, 2);</literal> will + return the name of the second field in the result set associated with + the result identifier. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-field-seek"> - <refnamediv> - <refname>msql_field_seek</refname> - <refpurpose>Set field offset</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_field_seek</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - Seeks to the specified field offset. If the next call to - <function>msql_fetch_field</function> won't include a field - offset, this field would be returned. - </para> - <para> - This function returns &false; on failure. - </para> - <para> - See also: <function>msql_fetch_field</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-seek"> + <refnamediv> + <refname>msql_field_seek</refname> + <refpurpose>Set field offset</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_field_seek</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + Seeks to the specified field offset. If the next call to + <function>msql_fetch_field</function> won't include a field + offset, this field would be returned. + </para> + <para> + This function returns &false; on failure. + </para> + <para> + See also: <function>msql_fetch_field</function>. + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-field-table"> - <refnamediv> - <refname>msql_field_table</refname> - <refpurpose>Get table name for field</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_field_table</methodname> - <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field</parameter></methodparam> - </methodsynopsis> - <para> - Returns the name of the table <parameter>field</parameter> was - fetched from. - </para> - <para> - This function returns &false; on failure. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-table"> + <refnamediv> + <refname>msql_field_table</refname> + <refpurpose>Get table name for field</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_field_table</methodname> + <methodparam><type>int</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field</parameter></methodparam> + </methodsynopsis> + <para> + Returns the name of the table <parameter>field</parameter> was + fetched from. + </para> + <para> + This function returns &false; on failure. + </para> + </refsect1> +</refentry>  - <refentry id="function.msql-field-type"> - <refnamediv> - <refname>msql_field_type</refname> - <refpurpose>Get field type</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>msql_field_type</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_field_type</function> is similar to the - <function>msql_field_name</function> function. The arguments are - identical, but the field type is returned. This will be one of - "int", "char" or "real". - </para> - <para> - This function returns &false; on failure. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-field-type"> + <refnamediv> + <refname>msql_field_type</refname> + <refpurpose>Get field type</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>msql_field_type</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_field_type</function> is similar to the + <function>msql_field_name</function> function. The arguments are + identical, but the field type is returned. This will be one of + "int", "char" or "real". + </para> + <para> + This function returns &false; on failure. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fieldflags"> - <refnamediv> - <refname>msql_fieldflags</refname> - <refpurpose>Alias of <function>msql_field_flags</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_field_flags</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fieldflags"> + <refnamediv> + <refname>msql_fieldflags</refname> + <refpurpose>Alias of <function>msql_field_flags</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_field_flags</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fieldlen"> - <refnamediv> - <refname>msql_fieldlen</refname> - <refpurpose>Alias of <function>msql_field_len</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_field_len</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fieldlen"> + <refnamediv> + <refname>msql_fieldlen</refname> + <refpurpose>Alias of <function>msql_field_len</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_field_len</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fieldname"> - <refnamediv> - <refname>msql_fieldname</refname> - <refpurpose>Alias of <function>msql_field_name</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_field_name</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fieldname"> + <refnamediv> + <refname>msql_fieldname</refname> + <refpurpose>Alias of <function>msql_field_name</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_field_name</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fieldtable"> - <refnamediv> - <refname>msql_fieldtable</refname> - <refpurpose>Alias of <function>msql_field_table</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_field_table</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fieldtable"> + <refnamediv> + <refname>msql_fieldtable</refname> + <refpurpose>Alias of <function>msql_field_table</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_field_table</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-fieldtype"> - <refnamediv> - <refname>msql_fieldtype</refname> - <refpurpose>Alias of <function>msql_field_type</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_field_type</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-fieldtype"> + <refnamediv> + <refname>msql_fieldtype</refname> + <refpurpose>Alias of <function>msql_field_type</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_field_type</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-free-result"> - <refnamediv> - <refname>msql_free_result</refname> - <refpurpose>Free result memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_free_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_free_result</function> frees the memory associated - with <parameter>query_identifier</parameter>. When PHP completes a - request, this memory is freed automatically, so you only need to - call this function when you want to make sure you don't use too - much memory while the script is running. - </para> - <para> - For downward compatibility, the alias named - <function>msql_freeresult</function> may be used. This, however, is - deprecated and not recommended. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-free-result"> + <refnamediv> + <refname>msql_free_result</refname> + <refpurpose>Free result memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_free_result</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_free_result</function> frees the memory associated + with <parameter>query_identifier</parameter>. When PHP completes a + request, this memory is freed automatically, so you only need to + call this function when you want to make sure you don't use too + much memory while the script is running. + </para> + <para> + For downward compatibility, the alias named + <function>msql_freeresult</function> may be used. This, however, is + deprecated and not recommended. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-list-dbs"> - <refnamediv> - <refname>msql_list_dbs</refname> - <refpurpose>List mSQL databases on server</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msql_list_dbs</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_list_dbs</function> will return a result pointer - containing the databases available from the current msql - daemon. Use the <function>msql_result</function> function to - traverse this result pointer. - </para> - <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-list-dbs"> + <refnamediv> + <refname>msql_list_dbs</refname> + <refpurpose>List mSQL databases on server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msql_list_dbs</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_list_dbs</function> will return a result pointer + containing the databases available from the current msql + daemon. Use the <function>msql_result</function> function to + traverse this result pointer. + </para> + <para> + For downward compatibility, the alias named + <function>msql_listtables</function> may be used. This, however, is + deprecated and not recommended. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-list-fields"> - <refnamediv> - <refname>msql_list_fields</refname> - <refpurpose>List result fields</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msql_list_fields</methodname> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - <methodparam><type>string</type><parameter>tablename</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_list_fields</function> retrieves information about - the given <parameter>tablename</parameter>. The returned result set can - be traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. - </para> - <para> - This function returns &false; on failure. - </para> - <para> - For downward compatibility, the alias named - <function>msql_listfields</function> may be used. This, however, is - deprecated and not recommended. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-list-fields"> + <refnamediv> + <refname>msql_list_fields</refname> + <refpurpose>List result fields</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msql_list_fields</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam><type>string</type><parameter>tablename</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_list_fields</function> retrieves information about + the given <parameter>tablename</parameter>. The returned result set can + be traversed with any function that fetches result sets, such as + <function>msql_fetch_array</function>. + </para> + <para> + This function returns &false; on failure. + </para> + <para> + For downward compatibility, the alias named + <function>msql_listfields</function> may be used. This, however, is + deprecated and not recommended. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-list-tables"> - <refnamediv> - <refname>msql_list_tables</refname> - <refpurpose>List tables in an mSQL database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msql_list_tables</methodname> - <methodparam><type>string</type><parameter>database</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_list_tables</function> lists the tables on the specified - <parameter>database</parameter>. It returns a result set which may be - traversed with any function that fetches result sets, such as - <function>msql_fetch_array</function>. - </para> - <para> - This function returns &false; on failure. - </para> - <para> - For downward compatibility, the alias named - <function>msql_listtables</function> may be used. This, however, is - deprecated and not recommended. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-list-tables"> + <refnamediv> + <refname>msql_list_tables</refname> + <refpurpose>List tables in an mSQL database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msql_list_tables</methodname> + <methodparam><type>string</type><parameter>database</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_list_tables</function> lists the tables on the specified + <parameter>database</parameter>. It returns a result set which may be + traversed with any function that fetches result sets, such as + <function>msql_fetch_array</function>. + </para> + <para> + This function returns &false; on failure. + </para> + <para> + For downward compatibility, the alias named + <function>msql_listtables</function> may be used. This, however, is + deprecated and not recommended. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-num-fields"> - <refnamediv> - <refname>msql_num_fields</refname> - <refpurpose>Get number of fields in result</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_num_fields</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_num_fields</function> returns the number of fields - in a result set. - </para> - <para> - For downwards compatibility, the alias named - <function>msql_numfields</function> may be used. This, however, is - deprecated and not recommended. - </para> - <para> - See also: <function>msql_query</function>, - <function>msql_fetch_field</function>, and - <function>msql_num_rows</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-num-fields"> + <refnamediv> + <refname>msql_num_fields</refname> + <refpurpose>Get number of fields in result</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_num_fields</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_num_fields</function> returns the number of fields + in a result set. + </para> + <para> + For downwards compatibility, the alias named + <function>msql_numfields</function> may be used. This, however, is + deprecated and not recommended. + </para> + <para> + See also: <function>msql_query</function>, + <function>msql_fetch_field</function>, and + <function>msql_num_rows</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-num-rows"> - <refnamediv> - <refname>msql_num_rows</refname> - <refpurpose>Get number of rows in result</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_num_rows</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_num_rows</function> returns the number of rows in - a result set. - </para> - <para> - For downwards compatibility, the alias named - <function>msql_numrows</function> may be used. This, however is - deprecated and not recommended. - </para> - <para> - See also: <function>msql_db_query</function> and - <function>msql_query</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-num-rows"> + <refnamediv> + <refname>msql_num_rows</refname> + <refpurpose>Get number of rows in result</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_num_rows</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_num_rows</function> returns the number of rows in + a result set. + </para> + <para> + For downwards compatibility, the alias named + <function>msql_numrows</function> may be used. This, however is + deprecated and not recommended. + </para> + <para> + See also: <function>msql_db_query</function> and + <function>msql_query</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-numfields"> - <refnamediv> - <refname>msql_numfields</refname> - <refpurpose>Alias of <function>msql_num_fields</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_num_fields</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-numfields"> + <refnamediv> + <refname>msql_numfields</refname> + <refpurpose>Alias of <function>msql_num_fields</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_num_fields</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-numrows"> - <refnamediv> - <refname>msql_numrows</refname> - <refpurpose>Alias of <function>msql_num_rows</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_num_rows</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-numrows"> + <refnamediv> + <refname>msql_numrows</refname> + <refpurpose>Alias of <function>msql_num_rows</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_num_rows</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-pconnect"> - <refnamediv> - <refname>msql_pconnect</refname> - <refpurpose>Open persistent mSQL connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>msql_pconnect</methodname> - <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_pconnect</function> acts very much like - <function>msql_connect</function> with two major differences. - </para> - <para> - First, when connecting, the function would first try to - find a (persistent) link that's already open with the same host. - If one is found, an identifier for it will be returned instead of - opening a new connection. - </para> - <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 (<function>msql_close</function> will not - close links established by <function>msql_pconnect</function>). - </para> - <para> - Returns a positive mSQL persistent link identifier on success, or - &false; on error. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-pconnect"> + <refnamediv> + <refname>msql_pconnect</refname> + <refpurpose>Open persistent mSQL connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>msql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_pconnect</function> acts very much like + <function>msql_connect</function> with two major differences. + </para> + <para> + First, when connecting, the function would first try to + find a (persistent) link that's already open with the same host. + If one is found, an identifier for it will be returned instead of + opening a new connection. + </para> + <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 (<function>msql_close</function> will not + close links established by <function>msql_pconnect</function>). + </para> + <para> + Returns a positive mSQL persistent link identifier on success, or + &false; on error. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-query"> - <refnamediv> - <refname>msql_query</refname> - <refpurpose>Send mSQL query</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>msql_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_query</function> sends a query to the currently - active database on the server that's associated with the - specified link identifier. If the link identifier isn't - specified, the last opened link is assumed. If no link is open, - the function tries to establish a link as if - <function>msql_connect</function> was called, and use it. - </para> - <para> - Returns a positive mSQL query identifier on success, or &false; on - error. - </para> - <example> - <title><function>msql_query</function> example</title> - <programlisting role="php"> + +<refentry id="function.msql-query"> + <refnamediv> + <refname>msql_query</refname> + <refpurpose>Send mSQL query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>msql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_query</function> sends a query to the currently + active database on the server that's associated with the + specified link identifier. If the link identifier isn't + specified, the last opened link is assumed. If no link is open, + the function tries to establish a link as if + <function>msql_connect</function> was called, and use it. + </para> + <para> + Returns a positive mSQL query identifier on success, or &false; on + error. + </para> + <para> + <example> + <title><function>msql_query</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $link = msql_connect("dbserver") @@ -45,16 +45,17 @@ } ?> ]]> - </programlisting> - </example> - <para> - See also - <function>msql_db_query</function>, - <function>msql_select_db</function>, and - <function>msql_connect</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also + <function>msql_db_query</function>, + <function>msql_select_db</function>, and + <function>msql_connect</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-regcase"> - <refnamediv> - <refname>msql_regcase</refname> - <refpurpose>Alias of <function>sql_regcase</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>sql_regcase</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-regcase"> + <refnamediv> + <refname>msql_regcase</refname> + <refpurpose>Alias of <function>sql_regcase</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>sql_regcase</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-result"> - <refnamediv> - <refname>msql_result</refname> - <refpurpose>Get result data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>msql_result</methodname> - <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>row</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam> - </methodsynopsis> - <para> - Returns the contents of the cell at the row and offset in the - specified mSQL result set. - </para> - <para> - <function>msql_result</function> returns the contents of one cell - from a mSQL result set. The field argument can be the field's - offset, or the field's name, or the field's table dot field's - name (fieldname.tablename). If the column name has been aliased - ('select foo as bar from ...'), use the alias instead of the - column name. - </para> - <para> - 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 are often much quicker than - <function>msql_result</function>. Also, note that specifying a - numeric offset for the field argument is much quicker than - specifying a fieldname or tablename.fieldname argument. - </para> - <para> - Recommended high-performance alternatives: - <function>msql_fetch_row</function>, - <function>msql_fetch_array</function>, and - <function>msql_fetch_object</function>. - </para> - <para> - For downward compatibility, the aliases named - <function>msql</function>, <function>msql_tablename</function>, and - <function>msql_dbname</function> may be used. This, however, is - deprecated and not recommended. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-result"> + <refnamediv> + <refname>msql_result</refname> + <refpurpose>Get result data</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>msql_result</methodname> + <methodparam><type>resource</type><parameter>query_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> + <para> + Returns the contents of the cell at the row and offset in the + specified mSQL result set. + </para> + <para> + <function>msql_result</function> returns the contents of one cell + from a mSQL result set. The field argument can be the field's + offset, or the field's name, or the field's table dot field's + name (fieldname.tablename). If the column name has been aliased + ('select foo as bar from ...'), use the alias instead of the + column name. + </para> + <para> + 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 are often much quicker than + <function>msql_result</function>. Also, note that specifying a + numeric offset for the field argument is much quicker than + specifying a fieldname or tablename.fieldname argument. + </para> + <para> + Recommended high-performance alternatives: + <function>msql_fetch_row</function>, + <function>msql_fetch_array</function>, and + <function>msql_fetch_object</function>. + </para> + <para> + For downward compatibility, the aliases named + <function>msql</function>, <function>msql_tablename</function>, and + <function>msql_dbname</function> may be used. This, however, is + deprecated and not recommended. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-select-db"> - <refnamediv> - <refname>msql_select_db</refname> - <refpurpose>Select mSQL database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>msql_select_db</methodname> - <methodparam><type>string</type><parameter>database_name</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>msql_select_db</function> sets the current active - database on the server that's associated with the specified - <parameter>link_identifier</parameter>. 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 - <function>msql_connect</function> was called, and use it. - </para> - <para> - &return.success; - </para> - <para> - Subsequent calls to <function>msql_query</function> will be - made on the active database. - </para> - <para> - For downward compatibility, the alias named - <function>msql_selectdb</function> may be used. This, however, is - deprecated and not recommended. - </para> - <para> - See also - <function>msql_connect</function>, - <function>msql_pconnect</function>, and - <function>msql_query</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-select-db"> + <refnamediv> + <refname>msql_select_db</refname> + <refpurpose>Select mSQL database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>msql_select_db</methodname> + <methodparam><type>string</type><parameter>database_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>msql_select_db</function> sets the current active + database on the server that's associated with the specified + <parameter>link_identifier</parameter>. 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 + <function>msql_connect</function> was called, and use it. + </para> + <para> + &return.success; + </para> + <para> + Subsequent calls to <function>msql_query</function> will be + made on the active database. + </para> + <para> + For downward compatibility, the alias named + <function>msql_selectdb</function> may be used. This, however, is + deprecated and not recommended. + </para> + <para> + See also + <function>msql_connect</function>, + <function>msql_pconnect</function>, and + <function>msql_query</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql-tablename"> - <refnamediv> - <refname>msql_tablename</refname> - <refpurpose>Alias of <function>msql_result</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_result</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql-tablename"> + <refnamediv> + <refname>msql_tablename</refname> + <refpurpose>Alias of <function>msql_result</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_result</function>. + </para> + </refsect1> +</refentry>  - - <refentry id="function.msql"> - <refnamediv> - <refname>msql</refname> - <refpurpose>Alias of <function>msql_db_query</function></refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - This function is an alias of <function>msql_db_query</function>. - </para> - </refsect1> - </refentry> + +<refentry id="function.msql"> + <refnamediv> + <refname>msql</refname> + <refpurpose>Alias of <function>msql_db_query</function></refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <para> + This function is an alias of <function>msql_db_query</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: