Source of: /manual/en/function.stream-context-set-params.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.stream.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.stream-context-set-params.php',
1 => 'stream_context_set_params',
),
'up' =>
array (
0 => 'ref.stream.php',
1 => 'Stream Functions',
),
'prev' =>
array (
0 => 'function.stream-context-set-option.php',
1 => 'stream_context_set_option',
),
'next' =>
array (
0 => 'function.stream-copy-to-stream.php',
1 => 'stream_copy_to_stream',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.stream-context-set-params" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_context_set_params</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">stream_context_set_params</span> — <span class="dc-title">Set parameters for a stream/wrapper/context</span></p>
</div>
<a name="function.stream-context-set-params.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>stream_context_set_params</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$stream_or_context</tt></span>
, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$params</tt></span>
)</div>
<p class="para rdfs-comment">
Sets parameters on the specified context.
</p>
</div>
<a name="function.stream-context-set-params.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">stream_or_context</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The stream or context to apply the parameters too.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">params</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
An array of parameters to set.
</p>
<blockquote><p><b class="note">Note</b>:
<i><tt class="parameter">params</tt></i>
should be an associative array of the structure:
<i>$params['paramname'] = "paramvalue";</i>.
<br />
</p></blockquote>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.stream-context-set-params.options"></a><div class="refsect1 options">
<h3 class="title">Supported parameters</h3>
<table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Parameters</th>
<th>Purpose</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left"><i>notification</i></td>
<td align="left">
Name of user-defined callback function to be called whenever a stream triggers a notification.
</td>
</tr>
<tr valign="middle">
<td align="left"><i>options</i></td>
<td align="left">
Array of options as in <a href="context.php" class="link">context options and
parameters</a>.
</td>
</tr>
</tbody>
</table>
</div>
<a name="function.stream-context-set-params.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
</div><?php manual_footer(); ?>
