php-doc-en/reference/stream/functions/stream-context-get-params.xml
George Peter Banyard 95d6121ed0 Remove See Also link to the current function
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347574 c90b9560-bf6c-de11-be94-00142212c4b1
2019-06-08 13:12:35 +00:00

112 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.stream-context-get-params" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>stream_context_get_params</refname>
<refpurpose>Retrieves parameters from a context</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>stream_context_get_params</methodname>
<methodparam><type>resource</type><parameter>stream_or_context</parameter></methodparam>
</methodsynopsis>
<para>
Retrieves parameter and options information from the stream or context.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stream_or_context</parameter></term>
<listitem>
<para>
A stream <type>resource</type> or a
<link linkend="context">context</link> <type>resource</type>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associate array containing all context options and parameters.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>stream_context_get_params</function> example</title>
<para>
Basic usage example
</para>
<programlisting role="php">
<![CDATA[
<?php
$ctx = stream_context_create();
$params = array("notification" => "stream_notification_callback");
stream_context_set_params($ctx, $params);
var_dump(stream_context_get_params($ctx));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
array(2) {
["notification"]=>
string(28) "stream_notification_callback"
["options"]=>
array(0) {
}
}
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_context_set_option</function></member>
<member><function>stream_context_set_params</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
-->