MYSQLI_FETCH_FIELD_DIRECT(3) 1 MYSQLI_FETCH_FIELD_DIRECT(3)
mysqli_result::fetch_field_direct - Fetch meta-data for a single field
Object oriented style
SYNOPSIS
object mysqli_result::fetch_field_direct (int $fieldnr)
DESCRIPTION
Procedural style
object mysqli_fetch_field_direct (mysqli_result $result, int $fieldnr)
Returns an object which contains field definition information from the specified result set.
PARAMETERS
o $
result -Procedural style only: A result set identifier returned by mysqli_query(3), mysqli_store_result(3) or
mysqli_use_result(3).
o $fieldnr
- The field number. This value must be in the range from 0 to number of fields - 1.
RETURN VALUES
Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available.
Object attributes
+-----------+---------------------------------------------------+
|Attribute | |
| | |
| | Description |
| | |
+-----------+---------------------------------------------------+
| name | |
| | |
| | The name of the column |
| | |
| orgname | |
| | |
| | Original column name if an alias was specified |
| | |
| table | |
| | |
| | The name of the table this field belongs to (if |
| | not calculated) |
| | |
| orgtable | |
| | |
| | Original table name if an alias was specified |
| | |
| def | |
| | |
| | The default value for this field, represented as |
| | a string |
| | |
|max_length | |
| | |
| | The maximum width of the field for the result |
| | set. |
| | |
| length | |
| | |
| | The width of the field, as specified in the table |
| | definition. |
| | |
|charsetnr | |
| | |
| | The character set number for the field. |
| | |
| flags | |
| | |
| | An integer representing the bit-flags for the |
| | field. |
| | |
| type | |
| | |
| | The data type used for this field |
| | |
| decimals | |
| | |
| | The number of decimals used (for numeric fields) |
| | |
+-----------+---------------------------------------------------+
EXAMPLES
Example #1
Object oriented style
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s
", mysqli_connect_error());
exit();
}
$query = "SELECT Name, SurfaceArea from Country ORDER BY Name LIMIT 5";
if ($result = $mysqli->query($query)) {
/* Get field information for column 'SurfaceArea' */
$finfo = $result->fetch_field_direct(1);
printf("Name: %s
", $finfo->name);
printf("Table: %s
", $finfo->table);
printf("max. Len: %d
", $finfo->max_length);
printf("Flags: %d
", $finfo->flags);
printf("Type: %d
", $finfo->type);
$result->close();
}
/* close connection */
$mysqli->close();
?>
Example #2
Procedural style
<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s
", mysqli_connect_error());
exit();
}
$query = "SELECT Name, SurfaceArea from Country ORDER BY Name LIMIT 5";
if ($result = mysqli_query($link, $query)) {
/* Get field information for column 'SurfaceArea' */
$finfo = mysqli_fetch_field_direct($result, 1);
printf("Name: %s
", $finfo->name);
printf("Table: %s
", $finfo->table);
printf("max. Len: %d
", $finfo->max_length);
printf("Flags: %d
", $finfo->flags);
printf("Type: %d
", $finfo->type);
mysqli_free_result($result);
}
/* close connection */
mysqli_close($link);
?>
The above examples will output:
Name: SurfaceArea
Table: Country
max. Len: 10
Flags: 32769
Type: 4
SEE ALSO
mysqli_num_fields(3), mysqli_fetch_field(3), mysqli_fetch_fields(3).
PHP Documentation Group MYSQLI_FETCH_FIELD_DIRECT(3)