array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.sqlsrv-field-metadata.php', 1 => 'sqlsrv_field_metadata', 2 => 'Retrieves metadata for the fields of a statement prepared by sqlsrv_prepare or sqlsrv_query', ), 'up' => array ( 0 => 'ref.sqlsrv.php', 1 => 'SQLSRV Functions', ), 'prev' => array ( 0 => 'function.sqlsrv-fetch-object.php', 1 => 'sqlsrv_fetch_object', ), 'next' => array ( 0 => 'function.sqlsrv-free-stmt.php', 1 => 'sqlsrv_free_stmt', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/sqlsrv/functions/sqlsrv-field-metadata.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

sqlsrv_field_metadata

(No version information available, might only be in Git)

sqlsrv_field_metadata — Retrieves metadata for the fields of a statement prepared by sqlsrv_prepare() or sqlsrv_query()

Description

sqlsrv_field_metadata(resource $stmt): mixed

Retrieves metadata for the fields of a statement prepared by sqlsrv_prepare() or sqlsrv_query(). sqlsrv_field_metadata() can be called on a statement before or after statement execution.

Parameters

stmt
The statement resource for which metadata is returned.

Return Values

Returns an array of arrays on success. Otherwise, false is returned. Each returned array is described by the following table:
Array returned by sqlsrv_field_metadata
Key Description
Name The name of the field.
Type The numeric value for the SQL type.
Size The number of characters for fields of character type, the number of bytes for fields of binary type, or null for other types.
Precision The precision for types of variable precision, null for other types.
Scale The scale for types of variable scale, null for other types.
Nullable An enumeration indicating whether the column is nullable, not nullable, or if it is not known.
For more information, see » sqlsrv_field_metadata in the Microsoft SQLSRV documentation.

Examples

Example #1 sqlsrv_field_metadata() example

<?php
$serverName = "serverName\sqlexpress";
$connectionInfo = array( "Database"=>"AdventureWorks", "UID"=>"username", "PWD"=>"password");
$conn = sqlsrv_connect( $serverName, $connectionInfo);
if( $conn === false ) {
die( print_r( sqlsrv_errors(), true));
}

$sql = "SELECT * FROM Table_1";
$stmt = sqlsrv_prepare( $conn, $sql );

foreach( sqlsrv_field_metadata( $stmt ) as $fieldMetadata ) {
foreach( $fieldMetadata as $name => $value) {
echo "$name: $value<br />";
}
echo "<br />";
}
?>

See Also