cvs: phpdoc /en/reference/mssql/functions mssql-bind.xml mssql-close.xml mssql-connect.xml mssql-data-seek.xml mssql-execute.xml mssql-fetch-array.xml
mssql-fetch-assoc.xml mssql-fetch-batch.xml mssql-fetch-field.xml mssql-fetch-object.xml mssql-fetch-row.xml mssql-field-length.xml
mssql-field-name.xml mssql-field-seek.xml mssql-field-type.xml mssql-free-result.xml mssql-free-statement.xml mssql-get-last-message.xml
mssql-guid-string.xml mssql-init.xml mssql-min-error-severity.xml mssql-min-message-severity.xml mssql-next-result.xml mssql-num-fields.xml
mssql-num-rows.xml mssql-pconnect.xml mssql-query.xml mssql-result.xml mssql-rows-affected.xml mssql-select-db.xml

From:	Mehdi Achour	Date:	Sun, 04 Feb 2007 22:45:20 +0000
Subject:	cvs: phpdoc /en/reference/mssql/functions mssql-bind.xml mssql-close.xml mssql-connect.xml mssql-data-seek.xml mssql-execute.xml mssql-fetch-array.xml mssql-fetch-assoc.xml mssql-fetch-batch.xml mssql-fetch-field.xml mssql-fetch-object.xml mssql-fetch-row.xml mssql-field-length.xml mssql-field-name.xml mssql-field-seek.xml mssql-field-type.xml mssql-free-result.xml mssql-free-statement.xml mssql-get-last-message.xml mssql-guid-string.xml mssql-init.xml mssql-min-error-severity.xml mssql-min-message-severity.xml mssql-next-result.xml mssql-num-fields.xml mssql-num-rows.xml mssql-pconnect.xml mssql-query.xml mssql-result.xml mssql-rows-affected.xml mssql-select-db.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375267@lists.php.net to get a copy of this message

didou Sun Feb 4 22:45:20 2007 UTC Modified files: /phpdoc/en/reference/mssql/functions mssql-bind.xml mssql-close.xml mssql-connect.xml mssql-data-seek.xml mssql-execute.xml mssql-fetch-array.xml mssql-fetch-assoc.xml mssql-fetch-batch.xml mssql-fetch-field.xml mssql-fetch-object.xml mssql-fetch-row.xml mssql-field-length.xml mssql-field-name.xml mssql-field-seek.xml mssql-field-type.xml mssql-free-result.xml mssql-free-statement.xml mssql-get-last-message.xml mssql-guid-string.xml mssql-init.xml mssql-min-error-severity.xml mssql-min-message-severity.xml mssql-next-result.xml mssql-num-fields.xml mssql-num-rows.xml mssql-pconnect.xml mssql-query.xml mssql-result.xml mssql-rows-affected.xml mssql-select-db.xml Log: WS, prepare for new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mssql/functions/mssql-bind.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/mssql/functions/mssql-bind.xml diff -u phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.7 phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.8 --- phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.7 Wed Nov 10 08:30:33 2004 +++ phpdoc/en/reference/mssql/functions/mssql-bind.xml Sun Feb 4 22:45:19 2007 @@ -1,35 +1,33 @@ <?xml version="1.0" encoding="iso-8859-1"?> - +  - <refentry id='function.mssql-bind'> - <refnamediv> - <refname>mssql_bind</refname> - <refpurpose> - Adds a parameter to a stored procedure or a remote stored procedure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_bind</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam><type>string</type><parameter>param_name</parameter></methodparam> - <methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam> - <methodparam><type>int</type><parameter>type</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>is_output</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>is_null</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-bind'> + <refnamediv> + <refname>mssql_bind</refname> + <refpurpose>Adds a parameter to a stored procedure or a remote stored procedure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_bind</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam><type>string</type><parameter>param_name</parameter></methodparam> + <methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam> + <methodparam><type>int</type><parameter>type</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_output</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>is_null</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - <para> - See also <function>mssql_execute</function>, - <function>mssql_free_statement</function>, and - <function>mssql_init</function>. - </para> - </refsect1> - </refentry> + <para> + See also <function>mssql_execute</function>, + <function>mssql_free_statement</function>, and + <function>mssql_init</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-close"> - <refnamediv> - <refname>mssql_close</refname> - <refpurpose>Close MS SQL Server connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_close</methodname> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_close</function> closes the link to a MS SQL - Server 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>mssql_close</function> will not close persistent links - generated by <function>mssql_pconnect</function>. - </para> - <para> - See also - <function>mssql_connect</function>, and - <function>mssql_pconnect</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-close"> + <refnamediv> + <refname>mssql_close</refname> + <refpurpose>Close MS SQL Server connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_close</methodname> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_close</function> closes the link to a MS SQL + Server 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>mssql_close</function> will not close persistent links + generated by <function>mssql_pconnect</function>. + </para> + <para> + See also + <function>mssql_connect</function>, and + <function>mssql_pconnect</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-connect"> - <refnamediv> - <refname>mssql_connect</refname> - <refpurpose>Open MS SQL server connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>mssql_connect</methodname> - <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>new_link</parameter></methodparam> - </methodsynopsis> - <para> - Returns: A MS SQL link identifier on success, or &false; - on error. - </para> - <para> - <function>mssql_connect</function> establishes a connection to a - MS SQL server. The servername argument has to be a valid - servername that is defined in the 'interfaces' file. - </para> - <para> - In case a second call is made to - <function>mssql_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>mssql_close</function>. - </para> - <para> - See also <function>mssql_pconnect</function>, - <function>mssql_close</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-connect"> + <refnamediv> + <refname>mssql_connect</refname> + <refpurpose>Open MS SQL server connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>mssql_connect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>new_link</parameter></methodparam> + </methodsynopsis> + <para> + Returns: A MS SQL link identifier on success, or &false; + on error. + </para> + <para> + <function>mssql_connect</function> establishes a connection to a + MS SQL server. The servername argument has to be a valid + servername that is defined in the 'interfaces' file. + </para> + <para> + In case a second call is made to + <function>mssql_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>mssql_close</function>. + </para> + <para> + See also <function>mssql_pconnect</function>, + <function>mssql_close</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-data-seek"> - <refnamediv> - <refname>mssql_data_seek</refname> - <refpurpose>Moves internal row pointer</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_data_seek</methodname> - <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> - <methodparam><type>int</type><parameter>row_number</parameter></methodparam> - </methodsynopsis> - <para> - &return.success; - </para> - <para> - <function>mssql_data_seek</function> 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 <function>mssql_fetch_row</function> - would return that row. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-data-seek"> + <refnamediv> + <refname>mssql_data_seek</refname> + <refpurpose>Moves internal row pointer</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_data_seek</methodname> + <methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam> + <methodparam><type>int</type><parameter>row_number</parameter></methodparam> + </methodsynopsis> + <para> + &return.success; + </para> + <para> + <function>mssql_data_seek</function> 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 <function>mssql_fetch_row</function> + would return that row. + </para> + </refsect1> +</refentry>  +  - <refentry id='function.mssql-execute'> - <refnamediv> - <refname>mssql_execute</refname> - <refpurpose> - Executes a stored procedure on a MS SQL server database - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>mssql_execute</methodname> - <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>skip_results</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-execute'> + <refnamediv> + <refname>mssql_execute</refname> + <refpurpose>Executes a stored procedure on a MS SQL server database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>mssql_execute</methodname> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>skip_results</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - <note> - <simpara> - If the stored procedure returns parameters or a return value these will - be available after the call to <function>mssql_execute</function> unless - the stored procedure returns more than one result set. In that case - use <function>mssql_next_result</function> to shift through the results. - When the last result has been processed the output parameters and return - values will be available. - </simpara> - </note> - <para> - See also <function>mssql_bind</function>, - <function>mssql_free_statement</function>, and - <function>mssql_init</function>. - </para> - </refsect1> - </refentry> + <note> + <simpara> + If the stored procedure returns parameters or a return value these will + be available after the call to <function>mssql_execute</function> unless + the stored procedure returns more than one result set. In that case + use <function>mssql_next_result</function> to shift through the results. + When the last result has been processed the output parameters and return + values will be available. + </simpara> + </note> + <para> + See also <function>mssql_bind</function>, + <function>mssql_free_statement</function>, and + <function>mssql_init</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-fetch-array"> - <refnamediv> - <refname>mssql_fetch_array</refname> - <refpurpose> - Fetch a result row as an associative array, a numeric array, or both - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>mssql_fetch_array</methodname> - <methodparam><type>resource</type><parameter>result</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>mssql_fetch_array</function> is an extended version of - <function>mssql_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> - An important thing to note is that using - <function>mssql_fetch_array</function> is NOT significantly - slower than using <function>mssql_fetch_row</function>, while it - provides a significant added value. - </para> - &database.field-case; - &database.fetch-null; - <para> - For further details, also see - <function>mssql_fetch_row</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-fetch-array"> + <refnamediv> + <refname>mssql_fetch_array</refname> + <refpurpose>Fetch a result row as an associative array, a numeric array, or both</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mssql_fetch_array</methodname> + <methodparam><type>resource</type><parameter>result</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>mssql_fetch_array</function> is an extended version of + <function>mssql_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> + An important thing to note is that using + <function>mssql_fetch_array</function> is NOT significantly + slower than using <function>mssql_fetch_row</function>, while it + provides a significant added value. + </para> + &database.field-case; + &database.fetch-null; + <para> + For further details, also see + <function>mssql_fetch_row</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id='function.mssql-fetch-assoc'> - <refnamediv> - <refname>mssql_fetch_assoc</refname> - <refpurpose> - Returns an associative array of the current row in the result set specified by result_id - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>mssql_fetch_assoc</methodname> - <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-fetch-assoc'> + <refnamediv> + <refname>mssql_fetch_assoc</refname> + <refpurpose>Returns an associative array of the current row in the result set specified by result_id</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mssql_fetch_assoc</methodname> + <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id='function.mssql-fetch-batch'> - <refnamediv> - <refname>mssql_fetch_batch</refname> - <refpurpose> - Returns the next batch of records - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>mssql_fetch_batch</methodname> - <methodparam><type>resource</type><parameter>result_index</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-fetch-batch'> + <refnamediv> + <refname>mssql_fetch_batch</refname> + <refpurpose>Returns the next batch of records</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>mssql_fetch_batch</methodname> + <methodparam><type>resource</type><parameter>result_index</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-fetch-field"> - <refnamediv> - <refname>mssql_fetch_field</refname> - <refpurpose>Get field information</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>mssql_fetch_field</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> - </methodsynopsis> - <para> - Returns an object containing field information. - </para> - <para> - <function>mssql_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>mssql_fetch_field</function> is retrieved. - </para> - <para> - The properties of the object are: - </para> - <itemizedlist> - <listitem> - <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. - </simpara> - </listitem> - <listitem> - <simpara> - column_source - the table from which the column was taken - </simpara> - </listitem> - <listitem> - <simpara> - max_length - maximum length of the column - </simpara> - </listitem> - <listitem> - <simpara> - numeric - 1 if the column is numeric - </simpara> - </listitem> - <listitem> - <simpara> - type - the column type. - </simpara> - </listitem> - </itemizedlist> - <para> - See also <function>mssql_field_seek</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-fetch-field"> + <refnamediv> + <refname>mssql_fetch_field</refname> + <refpurpose>Get field information</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>mssql_fetch_field</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam> + </methodsynopsis> + <para> + Returns an object containing field information. + </para> + <para> + <function>mssql_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>mssql_fetch_field</function> is retrieved. + </para> + <para> + The properties of the object are: + </para> + <itemizedlist> + <listitem> + <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. + </simpara> + </listitem> + <listitem> + <simpara> + column_source - the table from which the column was taken + </simpara> + </listitem> + <listitem> + <simpara> + max_length - maximum length of the column + </simpara> + </listitem> + <listitem> + <simpara> + numeric - 1 if the column is numeric + </simpara> + </listitem> + <listitem> + <simpara> + type - the column type. + </simpara> + </listitem> + </itemizedlist> + <para> + See also <function>mssql_field_seek</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-fetch-object"> - <refnamediv> - <refname>mssql_fetch_object</refname> - <refpurpose>Fetch row as object</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>object</type><methodname>mssql_fetch_object</methodname> - <methodparam><type>resource</type><parameter>result</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>mssql_fetch_object</function> is similar to - <function>mssql_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> - &database.field-case; - &database.fetch-null; - <para> - Speed-wise, the function is identical to - <function>mssql_fetch_array</function>, and almost as quick as - <function>mssql_fetch_row</function> (the difference is - insignificant). - </para> - <para> - See also - <function>mssql_fetch_array</function>, and - <function>mssql_fetch_row</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-fetch-object"> + <refnamediv> + <refname>mssql_fetch_object</refname> + <refpurpose>Fetch row as object</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>object</type><methodname>mssql_fetch_object</methodname> + <methodparam><type>resource</type><parameter>result</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>mssql_fetch_object</function> is similar to + <function>mssql_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> + &database.field-case; + &database.fetch-null; + <para> + Speed-wise, the function is identical to + <function>mssql_fetch_array</function>, and almost as quick as + <function>mssql_fetch_row</function> (the difference is + insignificant). + </para> + <para> + See also + <function>mssql_fetch_array</function>, and + <function>mssql_fetch_row</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-fetch-row"> - <refnamediv> - <refname>mssql_fetch_row</refname> - <refpurpose>Get row as enumerated array</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>mssql_fetch_row</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para> - Returns: An array that corresponds to the fetched row, or &false; - if there are no more rows. - </para> - <para> - <function>mssql_fetch_row</function> 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. - </para> - <para> - Subsequent call to <function>mssql_fetch_row</function> would - return the next row in the result set, or &false; if there are no - more rows. - </para> - &database.fetch-null; - <para> - See also - <function>mssql_fetch_array</function>, - <function>mssql_fetch_object</function>, - <function>mssql_data_seek</function>, - <function>mssql_fetch_lengths</function>, and - <function>mssql_result</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-fetch-row"> + <refnamediv> + <refname>mssql_fetch_row</refname> + <refpurpose>Get row as enumerated array</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>mssql_fetch_row</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para> + Returns: An array that corresponds to the fetched row, or &false; + if there are no more rows. + </para> + <para> + <function>mssql_fetch_row</function> 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. + </para> + <para> + Subsequent call to <function>mssql_fetch_row</function> would + return the next row in the result set, or &false; if there are no + more rows. + </para> + &database.fetch-null; + <para> + See also + <function>mssql_fetch_array</function>, + <function>mssql_fetch_object</function>, + <function>mssql_data_seek</function>, + <function>mssql_fetch_lengths</function>, and + <function>mssql_result</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-field-length"> - <refnamediv> - <refname>mssql_field_length</refname> - <refpurpose>Get the length of a field</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>mssql_field_length</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> - <para> - This function returns the length of field no. <parameter>offset</parameter> in - result <parameter>result</parameter>. If <parameter>offset</parameter> is omitted, - the current field is used. - </para> - <note> - <title>Note to Win32 Users</title> - <simpara> - Due to a limitation in the underlying API used by PHP (MS DbLib C API), - the length of VARCHAR fields is limited to <emphasis>255</emphasis>. If - you need to store more data, use a TEXT field instead. - </simpara> - </note> - </refsect1> - </refentry> +<refentry id="function.mssql-field-length"> + <refnamediv> + <refname>mssql_field_length</refname> + <refpurpose>Get the length of a field</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>mssql_field_length</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> + <para> + This function returns the length of field no. <parameter>offset</parameter> in + result <parameter>result</parameter>. If <parameter>offset</parameter> is omitted, + the current field is used. + </para> + <note> + <title>Note to Win32 Users</title> + <simpara> + Due to a limitation in the underlying API used by PHP (MS DbLib C API), + the length of VARCHAR fields is limited to <emphasis>255</emphasis>. If + you need to store more data, use a TEXT field instead. + </simpara> + </note> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-field-name"> - <refnamediv> - <refname>mssql_field_name</refname> - <refpurpose>Get the name of a field</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>mssql_field_name</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> +<refentry id="function.mssql-field-name"> + <refnamediv> + <refname>mssql_field_name</refname> + <refpurpose>Get the name of a field</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mssql_field_name</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-field-seek"> - <refnamediv> - <refname>mssql_field_seek</refname> - <refpurpose>Seeks to the specified field offset</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_field_seek</methodname> - <methodparam><type>resource</type><parameter>result</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>mssql_fetch_field</function> won't include a field - offset, this field would be returned.</para> - <para> - &return.success; - </para> - <para> - See also <function>mssql_fetch_field</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-field-seek"> + <refnamediv> + <refname>mssql_field_seek</refname> + <refpurpose>Seeks to the specified field offset</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_field_seek</methodname> + <methodparam><type>resource</type><parameter>result</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>mssql_fetch_field</function> won't include a field + offset, this field would be returned.</para> + <para> + &return.success; + </para> + <para> + See also <function>mssql_fetch_field</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-field-type"> - <refnamediv> - <refname>mssql_field_type</refname> - <refpurpose>Gets the type of a field</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>mssql_field_type</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> - </methodsynopsis> +<refentry id="function.mssql-field-type"> + <refnamediv> + <refname>mssql_field_type</refname> + <refpurpose>Gets the type of a field</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mssql_field_type</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-free-result"> - <refnamediv> - <refname>mssql_free_result</refname> - <refpurpose>Free result memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_free_result</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_free_result</function> 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 <function>mssql_free_result</function> - with the result identifier as an argument and the associated - result memory will be freed. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-free-result"> + <refnamediv> + <refname>mssql_free_result</refname> + <refpurpose>Free result memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_free_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_free_result</function> 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 <function>mssql_free_result</function> + with the result identifier as an argument and the associated + result memory will be freed. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-free-statement"> - <refnamediv> - <refname>mssql_free_statement</refname> - <refpurpose>Free statement memory</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_free_statement</methodname> - <methodparam><type>resource</type><parameter>statement</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_free_statement</function> 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 <function>mssql_free_statement</function> - with the statement identifier as an argument and the associated - statement memory will be freed. - </para> - <para> - See also <function>mssql_bind</function>, - <function>mssql_execute</function>, and - <function>mssql_init</function> - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-free-statement"> + <refnamediv> + <refname>mssql_free_statement</refname> + <refpurpose>Free statement memory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_free_statement</methodname> + <methodparam><type>resource</type><parameter>statement</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_free_statement</function> 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 <function>mssql_free_statement</function> + with the statement identifier as an argument and the associated + statement memory will be freed. + </para> + <para> + See also <function>mssql_bind</function>, + <function>mssql_execute</function>, and + <function>mssql_init</function> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-get-last-message"> - <refnamediv> - <refname>mssql_get_last_message</refname> - <refpurpose> - Returns the last message from the server - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>mssql_get_last_message</methodname> - <void/> - </methodsynopsis> +<refentry id="function.mssql-get-last-message"> + <refnamediv> + <refname>mssql_get_last_message</refname> + <refpurpose>Returns the last message from the server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mssql_get_last_message</methodname> + <void/> + </methodsynopsis> - &warn.undocumented.func; - - </refsect1> - </refentry> + &warn.undocumented.func; + + </refsect1> +</refentry>  +  - <refentry id='function.mssql-guid-string'> - <refnamediv> - <refname>mssql_guid_string</refname> - <refpurpose> - Converts a 16 byte binary GUID to a string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>mssql_guid_string</methodname> - <methodparam><type>string</type><parameter>binary</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>short_format</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-guid-string'> + <refnamediv> + <refname>mssql_guid_string</refname> + <refpurpose>Converts a 16 byte binary GUID to a string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mssql_guid_string</methodname> + <methodparam><type>string</type><parameter>binary</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>short_format</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id='function.mssql-init'> - <refnamediv> - <refname>mssql_init</refname> - <refpurpose> - Initializes a stored procedure or a remote stored procedure - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>mssql_init</methodname> - <methodparam><type>string</type><parameter>sp_name</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>conn_id</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-init'> + <refnamediv> + <refname>mssql_init</refname> + <refpurpose>Initializes a stored procedure or a remote stored procedure</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>mssql_init</methodname> + <methodparam><type>string</type><parameter>sp_name</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>conn_id</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - <para> - See also <function>mssql_bind</function>, - <function>mssql_execute</function>, and - <function>mssql_free_statement</function> - </para> - </refsect1> - </refentry> + <para> + See also <function>mssql_bind</function>, + <function>mssql_execute</function>, and + <function>mssql_free_statement</function> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-min-error-severity"> - <refnamediv> - <refname>mssql_min_error_severity</refname> - <refpurpose>Sets the lower error severity</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>mssql_min_error_severity</methodname> - <methodparam><type>int</type><parameter>severity</parameter></methodparam> - </methodsynopsis> +<refentry id="function.mssql-min-error-severity"> + <refnamediv> + <refname>mssql_min_error_severity</refname> + <refpurpose>Sets the lower error severity</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>mssql_min_error_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-min-message-severity"> - <refnamediv> - <refname>mssql_min_message_severity</refname> - <refpurpose>Sets the lower message severity</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>void</type><methodname>mssql_min_message_severity</methodname> - <methodparam><type>int</type><parameter>severity</parameter></methodparam> - </methodsynopsis> +<refentry id="function.mssql-min-message-severity"> + <refnamediv> + <refname>mssql_min_message_severity</refname> + <refpurpose>Sets the lower message severity</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>void</type><methodname>mssql_min_message_severity</methodname> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-next-result"> - <refnamediv> - <refname>mssql_next_result</refname> - <refpurpose>Move the internal result pointer to the next result</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_next_result</methodname> - <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> - </methodsynopsis> - <para> - 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. The - function will return &true; if an additional result set was - available or &false; otherwise. - </para> - <example> - <title><function>mssql_next_result</function> example</title> - <programlisting role="php"> +<refentry id="function.mssql-next-result"> + <refnamediv> + <refname>mssql_next_result</refname> + <refpurpose>Move the internal result pointer to the next result</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_next_result</methodname> + <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> + </methodsynopsis> + <para> + 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. The + function will return &true; if an additional result set was + available or &false; otherwise. + </para> + <example> + <title><function>mssql_next_result</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $link = mssql_connect("localhost", "userid", "secret"); @@ -39,10 +39,10 @@ mssql_close($link); ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-num-fields"> - <refnamediv> - <refname>mssql_num_fields</refname> - <refpurpose>Gets the number of fields in result</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>mssql_num_fields</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_num_fields</function> returns the number of - fields in a result set. - </para> - <para> - See also - <function>mssql_query</function>, - <function>mssql_fetch_field</function>, and - <function>mssql_num_rows</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-num-fields"> + <refnamediv> + <refname>mssql_num_fields</refname> + <refpurpose>Gets the number of fields in result</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>mssql_num_fields</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_num_fields</function> returns the number of + fields in a result set. + </para> + <para> + See also + <function>mssql_query</function>, + <function>mssql_fetch_field</function>, and + <function>mssql_num_rows</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-num-rows"> - <refnamediv> - <refname>mssql_num_rows</refname> - <refpurpose>Gets the number of rows in result</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>mssql_num_rows</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_num_rows</function> returns the number of rows in - a result set. - </para> - <para> - See also - <function>mssql_query</function> and - <function>mssql_fetch_row</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-num-rows"> + <refnamediv> + <refname>mssql_num_rows</refname> + <refpurpose>Gets the number of rows in result</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>mssql_num_rows</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_num_rows</function> returns the number of rows in + a result set. + </para> + <para> + See also + <function>mssql_query</function> and + <function>mssql_fetch_row</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-pconnect"> - <refnamediv> - <refname>mssql_pconnect</refname> - <refpurpose>Open persistent MS SQL connection</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>mssql_pconnect</methodname> - <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>new_link</parameter></methodparam> - </methodsynopsis> - <para> - Returns: A positive MS SQL persistent link identifier on success, - or &false; on error. - </para> - <para> - <function>mssql_pconnect</function> acts very much like - <function>mssql_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, - username and password. 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>mssql_close</function> will not - close links established by <function>mssql_pconnect</function>). - </para> - <para> - This type of links is therefore called 'persistent'. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-pconnect"> + <refnamediv> + <refname>mssql_pconnect</refname> + <refpurpose>Open persistent MS SQL connection</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>mssql_pconnect</methodname> + <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>new_link</parameter></methodparam> + </methodsynopsis> + <para> + Returns: A positive MS SQL persistent link identifier on success, + or &false; on error. + </para> + <para> + <function>mssql_pconnect</function> acts very much like + <function>mssql_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, + username and password. 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>mssql_close</function> will not + close links established by <function>mssql_pconnect</function>). + </para> + <para> + This type of links is therefore called 'persistent'. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-query"> - <refnamediv> - <refname>mssql_query</refname> - <refpurpose>Send MS SQL query</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>mssql_query</methodname> - <methodparam><type>string</type><parameter>query</parameter></methodparam> - <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>batch_size</parameter></methodparam> - </methodsynopsis> - <para> - Returns: A MS SQL result resource on success, &true; if no - rows were returned, or &false; on error. - </para> - <para> - <function>mssql_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>mssql_connect</function> was called, and use it. - </para> - <para> - See also - <function>mssql_select_db</function> and - <function>mssql_connect</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-query"> + <refnamediv> + <refname>mssql_query</refname> + <refpurpose>Send MS SQL query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>mssql_query</methodname> + <methodparam><type>string</type><parameter>query</parameter></methodparam> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>batch_size</parameter></methodparam> + </methodsynopsis> + <para> + Returns: A MS SQL result resource on success, &true; if no + rows were returned, or &false; on error. + </para> + <para> + <function>mssql_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>mssql_connect</function> was called, and use it. + </para> + <para> + See also + <function>mssql_select_db</function> and + <function>mssql_connect</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-result"> - <refnamediv> - <refname>mssql_result</refname> - <refpurpose>Get result data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>mssql_result</methodname> - <methodparam><type>resource</type><parameter>result</parameter></methodparam> - <methodparam><type>int</type><parameter>row</parameter></methodparam> - <methodparam><type>mixed</type><parameter>field</parameter></methodparam> - </methodsynopsis> - <para> - <function>mssql_result</function> returns the contents of one - cell from a MS SQL result set. The field argument can be the - field's offset, the field's name or the field's table dot - field's name (tablename.fieldname). If the column name has been - aliased ('select foo as bar from...'), it uses 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're MUCH quicker than - <function>mssql_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>mssql_fetch_row</function>, - <function>mssql_fetch_array</function>, and - <function>mssql_fetch_object</function>. - </para> - </refsect1> - </refentry> +<refentry id="function.mssql-result"> + <refnamediv> + <refname>mssql_result</refname> + <refpurpose>Get result data</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>mssql_result</methodname> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> + <methodparam><type>int</type><parameter>row</parameter></methodparam> + <methodparam><type>mixed</type><parameter>field</parameter></methodparam> + </methodsynopsis> + <para> + <function>mssql_result</function> returns the contents of one + cell from a MS SQL result set. The field argument can be the + field's offset, the field's name or the field's table dot + field's name (tablename.fieldname). If the column name has been + aliased ('select foo as bar from...'), it uses 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're MUCH quicker than + <function>mssql_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>mssql_fetch_row</function>, + <function>mssql_fetch_array</function>, and + <function>mssql_fetch_object</function>. + </para> + </refsect1> +</refentry>  +  - <refentry id='function.mssql-rows-affected'> - <refnamediv> - <refname>mssql_rows_affected</refname> - <refpurpose> - Returns the number of records affected by the query - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>mssql_rows_affected</methodname> - <methodparam><type>resource</type><parameter>conn_id</parameter></methodparam> - </methodsynopsis> +<refentry id='function.mssql-rows-affected'> + <refnamediv> + <refname>mssql_rows_affected</refname> + <refpurpose>Returns the number of records affected by the query</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>int</type><methodname>mssql_rows_affected</methodname> + <methodparam><type>resource</type><parameter>conn_id</parameter></methodparam> + </methodsynopsis> - &warn.undocumented.func; + &warn.undocumented.func; - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.mssql-select-db"> - <refnamediv> - <refname>mssql_select_db</refname> - <refpurpose>Select MS SQL database</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>mssql_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> - &return.success; - </para> - <para> - <function>mssql_select_db</function> sets the current active - database on the server that's associated with the specified link - identifier. 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>mssql_connect</function> was - called, and use it. - </para> - <para> - Every subsequent call to <function>mssql_query</function> will be - made on the active database. - </para> - <para> - To escape the name of a database that contains spaces, hyphens ("-"), 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 "primary"). - </para> - <example> - <title><function>mssql_select_db</function> example</title> - <programlisting role="php"> +<refentry id="function.mssql-select-db"> + <refnamediv> + <refname>mssql_select_db</refname> + <refpurpose>Select MS SQL database</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>mssql_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> + &return.success; + </para> + <para> + <function>mssql_select_db</function> sets the current active + database on the server that's associated with the specified link + identifier. 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>mssql_connect</function> was + called, and use it. + </para> + <para> + Every subsequent call to <function>mssql_query</function> will be + made on the active database. + </para> + <para> + To escape the name of a database that contains spaces, hyphens ("-"), 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 "primary"). + </para> + <example> + <title><function>mssql_select_db</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $conn = mssql_connect('MYSQLSERVER', 'sa', 'password'); mssql_select_db('[my data-base]', $conn); ?> ]]> - </programlisting> - </example> - <para> See also: - <function>mssql_connect</function>, - <function>mssql_pconnect</function>, and - <function>mssql_query</function> - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> See also: + <function>mssql_connect</function>, + <function>mssql_pconnect</function>, and + <function>mssql_query</function> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: