Files
archived-doc-pt-br/reference/stream/streamwrapper/stream-set-option.xml
2024-05-20 13:50:26 -03:00

139 lines
4.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: de8e36659fb2b22c9b60ffa0380d9bea945b2819 Maintainer: leonardolara Status: ready -->
<refentry xml:id="streamwrapper.stream-set-option" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::stream_set_option</refname>
<refpurpose>Altera as opções do fluxo</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_set_option</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>int</type><parameter>arg1</parameter></methodparam>
<methodparam><type>int</type><parameter>arg2</parameter></methodparam>
</methodsynopsis>
<para>
Este método é chamado para definir as opções no fluxo.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
Uma das opções:
<simplelist>
<member><constant>STREAM_OPTION_BLOCKING</constant> (o método foi chamado em resposta a <function>stream_set_blocking</function>)</member>
<member><constant>STREAM_OPTION_READ_TIMEOUT</constant> (o método foi chamado em resposta a <function>stream_set_timeout</function>)</member>
<member><constant>STREAM_OPTION_READ_BUFFER</constant> (o método foi chamado em resposta a <function>stream_set_read_buffer</function>)</member>
<member><constant>STREAM_OPTION_WRITE_BUFFER</constant> (o método foi chamado em resposta a <function>stream_set_write_buffer</function>)</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg1</parameter></term>
<listitem>
<para>
Se <parameter>option</parameter> for
<simplelist>
<member><constant>STREAM_OPTION_BLOCKING</constant>: modo de bloqueio requerido (1 significa bloqueio e 0 sem bloqueio).</member>
<member><constant>STREAM_OPTION_READ_TIMEOUT</constant>: limite de tempo em segundos.</member>
<member><constant>STREAM_OPTION_READ_BUFFER</constant>: modo de buffer (<constant>STREAM_BUFFER_NONE</constant> ou <constant>STREAM_BUFFER_FULL</constant>).</member>
<member><constant>STREAM_OPTION_WRITE_BUFFER</constant>: modo de buffer (<constant>STREAM_BUFFER_NONE</constant> ou <constant>STREAM_BUFFER_FULL</constant>).</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg2</parameter></term>
<listitem>
<para>
Se <parameter>option</parameter> for
<simplelist>
<member><constant>STREAM_OPTION_BLOCKING</constant>: esta opção não está definida.</member>
<member><constant>STREAM_OPTION_READ_TIMEOUT</constant>: limite de tempo em microssegundos.</member>
<member><constant>STREAM_OPTION_READ_BUFFER</constant>: tamanho do buffer de leitura requerido.</member>
<member><constant>STREAM_OPTION_WRITE_BUFFER</constant>: tamanho do buffer de gravação requerido.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Se <parameter>option</parameter> não for implementada, &false; deve ser
retornado.
</para>
</refsect1>
<!--
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>streamWrapper::stream_set_option</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_set_blocking</function></member>
<member><function>stream_set_timeout</function></member>
<member><function>stream_set_write_buffer</function></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
-->