Files
php-doc-ru/reference/mysqli/mysqli_stmt/attr-set.xml
2024-10-29 19:06:07 +03:00

145 lines
6.1 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4683a073bf428da8cd06a9bc428a131292c42ba3 Maintainer: bfl Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="mysqli-stmt.attr-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqli_stmt::attr_set</refname>
<refname>mysqli_stmt_attr_set</refname>
<refpurpose>Изменяет поведение подготовленного запроса</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis role="mysqli_stmt">
<modifier>public</modifier> <type>bool</type><methodname>mysqli_stmt::attr_set</methodname>
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_stmt_attr_set</methodname>
<methodparam><type>mysqli_stmt</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>attribute</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Функция изменяет поведение подготовленного запроса. Функцию
вызывают несколько раз для установки нескольких атрибутов.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>&mysqli.stmt.description;<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
Атрибут, который требуется установить. Атрибут принимает следующие значения:
<table xml:id="mysqli-stmt.attr-set.parameters">
<title>Значения атрибута</title>
<tgroup cols="2">
<thead>
<row>
<entry>Символ</entry>
<entry>Описание</entry>
</row>
</thead>
<tbody>
<row>
<entry>MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH</entry>
<entry>
Если значение равно &true;, то функция <function>mysqli_stmt_store_result</function> обновляет
метаданные значением <literal>MYSQL_FIELD-&gt;max_length</literal>.
</entry>
</row>
<row>
<entry>MYSQLI_STMT_ATTR_CURSOR_TYPE</entry>
<entry>
Тип курсора, который нужно открыть для запроса при вызове функции <function>mysqli_stmt_execute</function>.
Параметр <parameter>value</parameter> принимает значения <constant>MYSQLI_CURSOR_TYPE_NO_CURSOR</constant>
(по умолчанию) или <constant>MYSQLI_CURSOR_TYPE_READ_ONLY</constant>.
</entry>
</row>
<row>
<entry>MYSQLI_STMT_ATTR_PREFETCH_ROWS</entry>
<entry>
Количество строк, которые необходимо получить с сервера с курсором за один раз.
Параметр <parameter>value</parameter> принимает значения в диапазоне от 1 до максимального значения
беззнакового целого числа long. По умолчанию значение равно 1.
Константа удалена с PHP 8.4.0.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
Если опцию <constant>MYSQLI_STMT_ATTR_CURSOR_TYPE</constant> указали вместе с
<constant>MYSQLI_CURSOR_TYPE_READ_ONLY</constant>, то курсор открывается для
запроса при вызове функции <function>mysqli_stmt_execute</function>. Если уже есть
открытый курсор из предыдущего вызова функции <function>mysqli_stmt_execute</function>,
то курсор закроется перед открытием нового. Функция <function>mysqli_stmt_reset</function>
также закрывает любой открытый курсор перед подготовкой запроса к повторному выполнению.
Функция <function>mysqli_stmt_free_result</function> закрывает любой открытый курсор.
</para>
<para>
Если курсор открывается для подготовленного запроса, вызывать функцию
<function>mysqli_stmt_store_result</function> не обязательно.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>Значение, которое функция присвоит атрибуту.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&mysqli.conditionalexception;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link xlink:href="&url.mysql.docs.stmt-attr-set;">Connector/MySQL mysql_stmt_attr_set()</link></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:"~/.phpdoc/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
-->