MYSQLI_STMT_STORE_RESULT(3) 1 MYSQLI_STMT_STORE_RESULT(3)
mysqli_stmt::store_result - Transfers a result set from a prepared statement
Object oriented style
SYNOPSIS
bool mysqli_stmt::store_result (void )
DESCRIPTION
Procedural style
bool mysqli_stmt_store_result (mysqli_stmt $stmt)
You must call mysqli_stmt_store_result(3) for every query that successfully produces a result set ( SELECT, SHOW, DESCRIBE, EXPLAIN), if
and only if you want to buffer the complete result set by the client, so that the subsequent mysqli_stmt_fetch(3) call returns buffered
data.
Note
It is unnecessary to call mysqli_stmt_store_result(3) for other queries, but if you do, it will not harm or cause any notable per-
formance in all cases. You can detect whether the query produced a result set by checking if mysqli_stmt_result_metadata(3) returns
NULL.
PARAMETERS
o $
stmt -Procedural style only: A statement identifier returned by mysqli_stmt_init(3).
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
Object oriented style
<?php
/* Open a connection */
$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, CountryCode FROM City ORDER BY Name LIMIT 20";
if ($stmt = $mysqli->prepare($query)) {
/* execute query */
$stmt->execute();
/* store result */
$stmt->store_result();
printf("Number of rows: %d.
", $stmt->num_rows);
/* free result */
$stmt->free_result();
/* close statement */
$stmt->close();
}
/* close connection */
$mysqli->close();
?>
Example #2
Procedural style
<?php
/* Open a connection */
$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, CountryCode FROM City ORDER BY Name LIMIT 20";
if ($stmt = mysqli_prepare($link, $query)) {
/* execute query */
mysqli_stmt_execute($stmt);
/* store result */
mysqli_stmt_store_result($stmt);
printf("Number of rows: %d.
", mysqli_stmt_num_rows($stmt));
/* free result */
mysqli_stmt_free_result($stmt);
/* close statement */
mysqli_stmt_close($stmt);
}
/* close connection */
mysqli_close($link);
?>
The above examples will output:
Number of rows: 20.
SEE ALSO
mysqli_prepare(3), mysqli_stmt_result_metadata(3), mysqli_stmt_fetch(3).
PHP Documentation Group MYSQLI_STMT_STORE_RESULT(3)