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:46:05 +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-969375268@lists.php.net to get a copy of this message

didou Sun Feb 4 22:46:05 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: ref.mssql: switch to new style Also document the following functions thanks to user notes mssql_bind(), mssql_execute(), mssql_fetch_assoc(), mssql_fetch_batch(), mssql_field_name(), mssql_field_type(), mssql_init()

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mssql/functions/mssql-bind.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/mssql/functions/mssql-bind.xml diff -u phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.8 phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.9 --- phpdoc/en/reference/mssql/functions/mssql-bind.xml:1.8 Sun Feb 4 22:45:19 2007 +++ phpdoc/en/reference/mssql/functions/mssql-bind.xml Sun Feb 4 22:46:04 2007 @@ -1,13 +1,13 @@ <?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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mssql_bind</methodname> <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> @@ -18,15 +18,139 @@ <methodparam choice="opt"><type>int</type><parameter>is_null</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam> </methodsynopsis> + <para> + Binds a parameter to a stored procedure or a remote stored procedure. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stmt</parameter></term> + <listitem> + <para> + Statement resource, obtained with <function>mssql_init</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>param_name</parameter></term> + <listitem> + <para> + The parameter name, as a string. + </para> + <note> + <para> + You have to include the <literal>@</literal> character, like in the + T-SQL syntax. See the included in <function>mssql_execute</function> + explanation. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>var</parameter></term> + <listitem> + <para> + The PHP variable you'll bind the MSSQL parameter to. You can pass it + by value, or by reference, to retrieve OUTPUT and RETVAL values after + the procedure execution. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>type</parameter></term> + <listitem> + <para> + One of: <constant>SQLTEXT</constant>, + <constant>SQLVARCHAR</constant>, <constant>SQLCHAR</constant>, + <constant>SQLINT1</constant>, <constant>SQLINT2</constant>, + <constant>SQLINT4</constant>, <constant>SQLBIT</constant>, + <constant>SQLFLT4</constant>, <constant>SQLFLT8</constant>, + <constant>SQLFLTN</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>is_output</parameter></term> + <listitem> + <para> + Wether the value is an OUTPUT parameter or not. If it's an OUTPUT + parameter and you don't mention it, it will be treated as a normal + input parameter and no error will be thrown. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>is_null</parameter></term> + <listitem> + <para> + Wether the parameter is &null; or not. Passing the &null; value as + <parameter>var</parameter> will not do the job. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>maxlen</parameter></term> + <listitem> + <para> + Used with char/varchar values. You have to indicate the length of the + data so if the parameter is a varchar(50), the type must be + <constant>SQLVARCHAR</constant> and this value <literal>50</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + <example> + <title><function>mssql_bind</function> Example</title> + <programlisting role="php"> +<![CDATA[ +<?php + +$cn = mssql_connect($DBSERVER, $DBUSER, $DBPASS); +mssql_select_db($DB, $cn); + +$sp = mssql_init("WDumpAdd"); // stored proc name - &warn.undocumented.func; +mssql_bind($sp, "@productname", stripslashes($newproduct), SQLVARCHAR, false, false, 150); +mssql_bind($sp, "@quantity", stripslashes($newquantity), SQLVARCHAR, false, false, 50); +mssql_execute($sp); +mssql_close($cn); + +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mssql_execute</function>, - <function>mssql_free_statement</function>, and - <function>mssql_init</function>. + <simplelist> + <member><function>mssql_execute</function></member> + <member><function>mssql_free_statement</function></member> + <member><function>mssql_init</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <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; + 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> Note that this isn't usually necessary, as non-persistent open links are automatically closed at the end of the script's execution. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>mssql_close</function> will not close persistent links - generated by <function>mssql_pconnect</function>. + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + A MS SQL link identifier, returned by + <function>mssql_connect</function>. + </para> + <para> + This function will not close persistent links generated by + <function>mssql_pconnect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mssql_connect</function>, and - <function>mssql_pconnect</function>. + &return.success; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_connect</function></member> + <member><function>mssql_pconnect</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>mssql_connect</methodname> <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> @@ -16,30 +16,80 @@ <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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - See also <function>mssql_pconnect</function>, - <function>mssql_close</function>. + <variablelist> + <varlistentry> + <term><parameter>servername</parameter></term> + <listitem> + <para> + The MS SQL server. It can also include a port number. e.g. + <literal>hostname:port</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The username. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_link</parameter></term> + <listitem> + <para> + If 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. This parameter + modifies this behavior and makes <function>mssql_connect</function> + always open a new link, even if <function>mssql_connect</function> was + called before with the same parameters. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a MS SQL link identifier on success, or &false; on error. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_close</function></member> + <member><function>mssql_pconnect</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <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 @@ -24,6 +21,37 @@ would return that row. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_identifier</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>row_number</parameter></term> + <listitem> + <para> + The desired row number of the new result pointer. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </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> + + <refsect1 role="description"> + &reftitle.description; <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> + <para> + Executes a stored procedure on a MS SQL server database + </para> + </refsect1> - &warn.undocumented.func; + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stmt</parameter></term> + <listitem> + <para> + Statement handle obtained with <function>mssql_init</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>skip_results</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; <note> - <simpara> + <para> 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> + </para> </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mssql_bind</function>, - <function>mssql_free_statement</function>, and - <function>mssql_init</function>. + <simplelist> + <member><function>mssql_bind</function></member> + <member><function>mssql_free_statement</function></member> + <member><function>mssql_init</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <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 @@ -29,13 +25,59 @@ slower than using <function>mssql_fetch_row</function>, while it provides a significant added value. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result_type</parameter></term> + <listitem> + <para> + The type of array that is to be fetched. It's a constant and can take + the following values: <constant>MSSQL_ASSOC</constant>, + <constant>MSSQL_NUM</constant>, and the default value of + <constant>MSSQL_BOTH</constant>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if there + are no more rows. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; &database.field-case; &database.fetch-null; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - For further details, also see - <function>mssql_fetch_row</function>. + <simplelist> + <member><function>mssql_fetch_row</function></member> + </simplelist> </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> + <refpurpose>Returns an associative array of the current row in the result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>mssql_fetch_assoc</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> </methodsynopsis> + <para> + Returns an associative array that corresponds to the fetched row and moves + the internal data pointer ahead. <function>mssql_fetch_assoc</function> is + equivalent to calling <function>mssql_fetch_array</function> with + <constant>MSSQL_ASSOC</constant> for the optional second parameter. + </para> + </refsect1> - &warn.undocumented.func; + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array that corresponds to the fetched row, or + &false; if there are no more rows. + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml diff -u phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml:1.4 phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml:1.5 --- phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml:1.4 Sun Feb 4 22:45:20 2007 +++ phpdoc/en/reference/mssql/functions/mssql-fetch-batch.xml Sun Feb 4 22:46:04 2007 @@ -1,21 +1,72 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mssql_fetch_batch</methodname> - <methodparam><type>resource</type><parameter>result_index</parameter></methodparam> + <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> + <para> + Returns the next batch of records + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the batch number as an integer. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + <example> + <title><function>mssql_fetch_batch</function> Example</title> + <programlisting role="php"> +<![CDATA[ +<?php - &warn.undocumented.func; +$resDb = mssql_connect('localhost', 'user', 'name'); +$result = mssql_query('SELECT * FROM MYTABLE', $resDb, 10000); +$intNumRows = mssql_num_rows($result); + +while ($intNumRows > 0) { + while ($arrRow = mssql_fetch_assoc($result)) { + // Do stuff ... + } + $intNumRows = mssql_fetch_batch($result); +?> +]]> + </programlisting> + </example> + </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> + + <refsect1 role="description"> + &reftitle.description; <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. + <function>mssql_fetch_field</function> can be used in order to + obtain information about fields in a certain query result. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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. + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field_offset</parameter></term> + <listitem> + <para> + The numerical field offset. If the field offset is not specified, the + next field that was not yet retrieved by this function is retrieved. The + <parameter>field_offset</parameter> starts at 0. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an object containing field information. </para> <para> The properties of the object are: @@ -54,8 +83,14 @@ </simpara> </listitem> </itemizedlist> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mssql_field_seek</function>. + <simplelist> + <member><function>mssql_field_seek</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml diff -u phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml:1.8 phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml:1.9 --- phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml:1.8 Sun Feb 4 22:45:20 2007 +++ phpdoc/en/reference/mssql/functions/mssql-fetch-object.xml Sun Feb 4 22:46:04 2007 @@ -1,42 +1,73 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id="function.mssql-fetch-object"> <refnamediv> <refname>mssql_fetch_object</refname> <refpurpose>Fetch row as object</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <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> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mssql_fetch_array</function>, and - <function>mssql_fetch_row</function>. + Returns an object with properties that correspond to the fetched row, or + &false; if there are no more rows. </para> </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + &database.field-case; + &database.fetch-null; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_fetch_array</function></member> + <member><function>mssql_fetch_row</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <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 @@ -27,16 +23,51 @@ return the next row in the result set, or &false; if there are no more rows. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array that corresponds to the fetched row, or &false; if there + are no more rows. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; &database.fetch-null; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <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>. + <simplelist> + <member><function>mssql_fetch_array</function></member> + <member><function>mssql_fetch_object</function></member> + <member><function>mssql_data_seek</function></member> + <member><function>mssql_fetch_lengths</function></member> + <member><function>mssql_result</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <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. + Returns the length of field no. <parameter>offset</parameter> in + <parameter>result</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The field offset, starts at 0. If omitted, the current field is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The length of the specified field index on success, or &false; on failure. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <note> <title>Note to Win32 Users</title> - <simpara> + <para> 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> + </para> + </note> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_field_name</function></member> + <member><function>mssql_field_type</function></member> + </simplelist> + </para> + </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> + + <refsect1 role="description"> + &reftitle.description; <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> + <para> + Returns the name of field no. <parameter>offset</parameter> in + <parameter>result</parameter>. + </para> + </refsect1> - &warn.undocumented.func; + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The field offset, starts at 0. If omitted, the current field is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The name of the specified field index on success, or &false; on failure. + </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_field_length</function></member> + <member><function>mssql_field_type</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mssql_field_seek</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> @@ -16,12 +16,48 @@ <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> + offset, this field would be returned. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field_offset</parameter></term> + <listitem> + <para> + The field offset, starts at 0. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>mssql_fetch_field</function>. + <simplelist> + <member><function>mssql_fetch_field</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mssql/functions/mssql-field-type.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/mssql/functions/mssql-field-type.xml diff -u phpdoc/en/reference/mssql/functions/mssql-field-type.xml:1.5 phpdoc/en/reference/mssql/functions/mssql-field-type.xml:1.6 --- phpdoc/en/reference/mssql/functions/mssql-field-type.xml:1.5 Sun Feb 4 22:45:20 2007 +++ phpdoc/en/reference/mssql/functions/mssql-field-type.xml Sun Feb 4 22:46:05 2007 @@ -1,22 +1,66 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <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> + + <refsect1 role="description"> + &reftitle.description; <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> + <para> + Returns the type of field no. <parameter>offset</parameter> in + <parameter>result</parameter>. + </para> + </refsect1> - &warn.undocumented.func; + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The field offset, starts at 0. If omitted, the current field is used. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The type of the specified field index on success, or &false; on failure. + </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_field_length</function></member> + <member><function>mssql_field_name</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mssql_free_result</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> @@ -21,6 +21,30 @@ result memory will be freed. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being freed. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mssql_free_statement</methodname> - <methodparam><type>resource</type><parameter>statement</parameter></methodparam> + <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> <para> <function>mssql_free_statement</function> only needs to be called @@ -20,12 +20,42 @@ with the statement identifier as an argument and the associated statement memory will be freed. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>stmt</parameter></term> + <listitem> + <para> + Statement resource, obtained with <function>mssql_init</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mssql_bind</function>, - <function>mssql_execute</function>, and - <function>mssql_init</function> + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_bind</function></member> + <member><function>mssql_execute</function></member> + <member><function>mssql_init</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mssql_get_last_message</methodname> <void/> @@ -16,6 +16,7 @@ &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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mssql_guid_string</methodname> <methodparam><type>string</type><parameter>binary</parameter></methodparam> @@ -17,6 +17,7 @@ &warn.undocumented.func; </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> + + <refsect1 role="description"> + &reftitle.description; <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> + <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> + <para> + Initializes a stored procedure or a remote stored procedure. + </para> + </refsect1> - &warn.undocumented.func; + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>sp_name</parameter></term> + <listitem> + <para> + Stored procedure name, like <literal>ownew.sp_name</literal> or + <literal>otherdb.owner.sp_name</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + A MS SQL link identifier, returned by + <function>mssql_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>mssql_bind</function>, - <function>mssql_execute</function>, and - <function>mssql_free_statement</function> + Returns a resource identifier "statement", used in subsequent calls to + <function>mssql_bind</function> and <function>mssql_execute</function>, + or &false; on errors. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_bind</function></member> + <member><function>mssql_execute</function></member> + <member><function>mssql_free_statement</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mssql_min_error_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> @@ -16,6 +16,28 @@ &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>severity</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>mssql_min_message_severity</methodname> <methodparam><type>int</type><parameter>severity</parameter></methodparam> @@ -16,6 +16,28 @@ &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>severity</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>mssql_next_result</methodname> <methodparam><type>resource</type><parameter>result_id</parameter></methodparam> @@ -18,30 +18,60 @@ 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. + and prepare to fetch the rows from the new result set. </para> - <example> - <title><function>mssql_next_result</function> example</title> - <programlisting role="php"> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result_id</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns &true; if an additional result set was available or &false; + otherwise. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>mssql_next_result</function> example</title> + <programlisting role="php"> <![CDATA[ <?php - $link = mssql_connect("localhost", "userid", "secret"); - mssql_select_db("MyDB", $link); - $SQL = "Select * from table1 select * from table2"; - $rs = mssql_query($SQL, $link); - do { - while ($row = mssql_fetch_row($rs)) { - } - } while (mssql_next_result($rs)); - mssql_free_result($rs); - mssql_close($link); +$link = mssql_connect("localhost", "userid", "secret"); +mssql_select_db("MyDB", $link); +$sql = "Select * from table1 select * from table2"; +$rs = mssql_query($sql, $link); +do { + while ($row = mssql_fetch_row($rs)) { + } +} while (mssql_next_result($rs)); +mssql_free_result($rs); +mssql_close($link); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mssql_num_fields</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> @@ -16,13 +16,43 @@ <function>mssql_num_fields</function> returns the number of fields in a result set. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mssql_query</function>, - <function>mssql_fetch_field</function>, and - <function>mssql_num_rows</function>. + Returns the number of fields, as an integer. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_query</function></member> + <member><function>mssql_fetch_field</function></member> + <member><function>mssql_num_rows</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mssql_num_rows</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> @@ -16,12 +16,42 @@ <function>mssql_num_rows</function> returns the number of rows in a result set. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mssql_query</function> and - <function>mssql_fetch_row</function>. + Returns the number of rows, as an integer. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_query</function></member> + <member><function>mssql_fetch_row</function></member> + </simplelist> + </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>mssql_pconnect</methodname> <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam> @@ -16,10 +16,6 @@ <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> @@ -39,6 +35,60 @@ This type of links is therefore called 'persistent'. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>servername</parameter></term> + <listitem> + <para> + The MS SQL server. It can also include a port number. e.g. + <literal>hostname:port</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>username</parameter></term> + <listitem> + <para> + The username. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>password</parameter></term> + <listitem> + <para> + The password. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>new_link</parameter></term> + <listitem> + <para> + If 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. This parameter + modifies this behavior and makes <function>mssql_connect</function> + always open a new link, even if <function>mssql_connect</function> was + called before with the same parameters. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a positive MS SQL persistent link identifier on success, or + &false; on error. + </para> + </refsect1> </refentry>  - + <refentry id="function.mssql-query"> <refnamediv> <refname>mssql_query</refname> <refpurpose>Send MS SQL query</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>mssql_query</methodname> <methodparam><type>string</type><parameter>query</parameter></methodparam> @@ -15,23 +15,69 @@ <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. + <function>mssql_query</function> sends a query to the currently active + database on the server that's associated with the specified link + identifier. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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. + <variablelist> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + A SQL query. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + A MS SQL link identifier, returned by + <function>mssql_connect</function> or + <function>mssql_pconnect</function>. + </para> + <para> + 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> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>batch_size</parameter></term> + <listitem> + <para> + The number of records to batch in the buffer. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also - <function>mssql_select_db</function> and - <function>mssql_connect</function>. + Returns a MS SQL result resource on success, &true; if no rows were + returned, or &false; on error. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_select_db</function></member> + <member><function>mssql_connect</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.mssql-result"> <refnamediv> <refname>mssql_result</refname> <refpurpose>Get result data</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>mssql_result</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> @@ -15,29 +15,86 @@ <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. + <function>mssql_result</function> returns the contents of one cell from a + MS SQL result set. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <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. + <variablelist> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + The result resource that is being evaluated. This result comes from a + call to <function>mssql_query</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>row</parameter></term> + <listitem> + <para> + The row number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + 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> + <note> + <para> + Specifying a numeric offset for the <parameter>field</parameter> + argument is much quicker than specifying a + <literal>fieldname</literal> or + <literal>tablename.fieldname</literal> argument. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the contents of the specified cell. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <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>. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> Recommended high-performance alternatives: - <function>mssql_fetch_row</function>, - <function>mssql_fetch_array</function>, and - <function>mssql_fetch_object</function>. + <simplelist> + <member><function>mssql_fetch_row</function></member> + <member><function>mssql_fetch_array</function></member> + <member><function>mssql_fetch_object</function></member> + </simplelist> </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> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>mssql_rows_affected</methodname> - <methodparam><type>resource</type><parameter>conn_id</parameter></methodparam> + <methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + A MS SQL link identifier, returned by + <function>mssql_connect</function> or + <function>mssql_pconnect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </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> + + <refsect1 role="description"> + &reftitle.description; <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. + identifier. </para> <para> Every subsequent call to <function>mssql_query</function> will be made on the active database. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>database_name</parameter></term> + <listitem> + <para> + The database name. + </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 <literal>primary</literal>). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>link_identifier</parameter></term> + <listitem> + <para> + A MS SQL link identifier, returned by + <function>mssql_connect</function> or + <function>mssql_pconnect</function>. + </para> + <para> + If no link identifier is specified, the last opened link is assumed. + If no link is open, the function will try to establish a link as if + <function>mssql_connect</function> was called, and use it. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <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"> + &return.success; + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <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); +$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> + </programlisting> + </example> </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>mssql_connect</function></member> + <member><function>mssql_pconnect</function></member> + <member><function>mssql_query</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file