php-doc-en/reference/mssql/functions/mssql-field-name.xml
Kalle Sommer Nielsen 8270283d6b News
* Added missing <literal> on setup note
* Added a reference to PDO_DBLIB and PDO_ODBC on setup note
* Added a source comment on mssql_connect() explaining how to use a connect with a custom port
* Added undocumented ini setting mssql.charset (available as of PHP 5.1.2)
* Added missing parameter descriptions on mssql_guid_string
* Added missing examples for
 * mssql_data_seek (Ross)
 * mssql_execute
 * mssql_fetch_array
 * mssql_fetch_assoc
 * mssql_fetch_field
 * mssql_fetch_object
 * mssql_fetch_row (RMLR)
 * mssql_field_length
 * mssql_field_name
 * mssql_field_seek
 * mssql_field_type
 * mssql_free_result
 * mssql_free_statement
 * mssql_get_last_message
 * mssql_guid_string
 * mssql_init
 * mssql_min_error_severity
 * mssql_min_message_severity
 * mssql_num_fields
 * mssql_pconnect (RMLR)
 * mssql_result
* Added constant descriptions
* Documented the following functions
 * mssql_get_last_message
 * mssql_min_error_severity
 * mssql_min_message_severity
* Changed examples on the following
 * mssql_bind
 * mssql_fetch_batch
 * mssql_next_result
 * mssql_query
* Fixed example on mssql_rows_affected


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@267081 c90b9560-bf6c-de11-be94-00142212c4b1
2008-10-08 18:29:23 +00:00

122 lines
2.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.mssql-field-name" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_field_name</refname>
<refpurpose>Get the name of a field</refpurpose>
</refnamediv>
<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>
<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="examples">
&reftitle.examples;
<para>
<example>
<title><function>mssql_field_name</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Send a select query to MSSQL
$query = mssql_query('SELECT [username], [name], [email] FROM [php].[dbo].[userlist]');
echo 'Result set contains the following field(s):', PHP_EOL;
// Dump all field names in result
for($i = 0; $i < mssql_num_fields($query); ++$i)
{
echo ' - ' . mssql_field_name($query, $i), PHP_EOL;
}
// Free the query result
mssql_free_result($query);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Result set contains the following field(s):
- username
- name
- email
]]>
</screen>
</example>
</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>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->