PHP mysqli_fetch_field_direct function

Like this blog? Consider exploring one of our sponsored banner ads...

mysqli_fetch_field_direct

(PHP 5)

mysqli_fetch_field_direct

(no version information, might be only in CVS)

result->fetch_field_direct() — Fetch meta-data for a single fieldDescription

Procedural style:

object mysqli_fetch_field_direct ( mysqli_result result, int fieldnr )

Object oriented style (method):

class mysqli_result {

object fetch_field_direct ( int fieldnr )

}

Returns an object which contains field definition informations from
specified resultset.

Parameters

result

Procedural style only: A result set
identifier returned by mysqli_query(), mysqli_store_result()
or mysqli_use_result().

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.

Table 1. Object attributes

AttributeDescriptionnameThe name of the columnorgnameOriginal column name if an alias was specifiedtableThe name of the table this field belongs to (if not calculated)orgtableOriginal table name if an alias was specifieddefThe default value for this field, represented as a stringmax_lengthThe maximum width of the field for the result set.lengthThe width of the field, as specified in the tabl definition.charsetnrThe character set number for the field.flagsAn integer representing the bit-flags for the field.typeThe data type used for this fielddecimalsThe number of decimals used (for integer fields)

Examples

Example 1. Object oriented style

$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
 
/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", 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\n", $finfo->name);
    printf("Table:    %s\n", $finfo->table);
    printf("max. Len: %d\n", $finfo->max_length);
    printf("Flags:    %d\n", $finfo->flags);
    printf("Type:     %d\n", $finfo->type);
 
    $result->close();
}
 
/* close connection */
$mysqli->close();

Example 2. Procedural style

$link = mysqli_connect("localhost", "my_user", "my_password", "world");
 
/* check connection */
if (mysqli_connect_errno()) {
    printf("Connect failed: %s\n", 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\n", $finfo->name);
    printf("Table:    %s\n", $finfo->table);
    printf("max. Len: %d\n", $finfo->max_length);
    printf("Flags:    %d\n", $finfo->flags);
    printf("Type:     %d\n", $finfo->type);
 
    mysqli_free_result($result);
}
 
/* close connection */
mysqli_close($link);

The above example will output:

Name: SurfaceArea
Table: Country
max. Len: 10
Flags: 32769
Type: 4See Also

mysqli_num_fields()mysqli_fetch_field()mysqli_fetch_fields()


About this entry

You’re currently reading “PHP mysqli_fetch_field_direct function,” an entry on BRADINO

Published:
2.26.07 / 12am
Category:
PHP Functions
Tags: