Source of: /manual/en/function.mssql-bind.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mssql.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.mssql-bind.php',
1 => 'mssql_bind',
),
'up' =>
array (
0 => 'ref.mssql.php',
1 => 'Mssql Functions',
),
'prev' =>
array (
0 => 'ref.mssql.php',
1 => 'Mssql Functions',
),
'next' =>
array (
0 => 'function.mssql-close.php',
1 => 'mssql_close',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.mssql-bind" class="refentry">
<div class="refnamediv">
<h1 class="refname">mssql_bind</h1>
<p class="verinfo">(PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)</p><p class="refpurpose"><span class="refname">mssql_bind</span> — <span class="dc-title">Adds a parameter to a stored procedure or a remote stored procedure</span></p>
</div>
<a name="function.mssql-bind.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>mssql_bind</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$stmt</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$param_name</tt></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter reference">&$var</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$is_output</tt><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$is_null</tt><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$maxlen</tt><span class="initializer"> = -1</span></span>
]]] )</div>
<p class="para rdfs-comment">
Binds a parameter to a stored procedure or a remote stored procedure.
</p>
</div>
<a name="function.mssql-bind.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">stmt</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Statement resource, obtained with <a href="function.mssql-init.php" class="function">mssql_init()</a>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">param_name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The parameter name, as a string.
</p>
<blockquote><p><b class="note">Note</b>:
You have to include the <i>@</i> character, like in the
T-SQL syntax. See the explanation included in
<a href="function.mssql-execute.php" class="function">mssql_execute()</a>.
<br />
</p></blockquote>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">var</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The PHP variable you'll bind the MSSQL parameter to. It is passed by
reference, to retrieve OUTPUT and RETVAL values after
the procedure execution.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
One of: <b><tt class="constant">SQLTEXT</tt></b>,
<b><tt class="constant">SQLVARCHAR</tt></b>, <b><tt class="constant">SQLCHAR</tt></b>,
<b><tt class="constant">SQLINT1</tt></b>, <b><tt class="constant">SQLINT2</tt></b>,
<b><tt class="constant">SQLINT4</tt></b>, <b><tt class="constant">SQLBIT</tt></b>,
<b><tt class="constant">SQLFLT4</tt></b>, <b><tt class="constant">SQLFLT8</tt></b>,
<b><tt class="constant">SQLFLTN</tt></b>.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">is_output</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Whether the value is an OUTPUT parameter or not. If it's an OUTPUT
parameter and you don't mention it, it will be treated as a normal
input parameter and no error will be thrown.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">is_null</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Whether the parameter is <b><tt class="constant">NULL</tt></b> or not. Passing the <b><tt class="constant">NULL</tt></b> value as
<i><tt class="parameter">var</tt></i>
will not do the job.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">maxlen</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Used with char/varchar values. You have to indicate the length of the
data so if the parameter is a varchar(50), the type must be
<b><tt class="constant">SQLVARCHAR</tt></b> and this value <i>50</i>.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.mssql-bind.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>
<a name="function.mssql-bind.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>mssql_bind()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Connect to MSSQL<br /></span><span style="color: #0000BB">mssql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'KALLESPC\SQLEXPRESS'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'phpfi'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mssql_select_db</span><span style="color: #007700">(</span><span style="color: #DD0000">'php'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Create a new stored prodecure<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">mssql_init</span><span style="color: #007700">(</span><span style="color: #DD0000">'NewUserRecord'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Bind the field names<br /></span><span style="color: #0000BB">mssql_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">'@username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Kalle'</span><span style="color: #007700">, </span><span style="color: #0000BB">SQLVARCHAR</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">60</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mssql_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">'@name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Kalle'</span><span style="color: #007700">, </span><span style="color: #0000BB">SQLVARCHAR</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">60</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mssql_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">'@age'</span><span style="color: #007700">, </span><span style="color: #0000BB">19</span><span style="color: #007700">, </span><span style="color: #0000BB">SQLINT1</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Execute <br /></span><span style="color: #0000BB">mssql_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Free statement<br /></span><span style="color: #0000BB">mssql_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.mssql-bind.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.mssql-execute.php" class="function" rel="rdfs-seeAlso">mssql_execute()</a> - Executes a stored procedure on a MS SQL server database</li>
<li class="member"><a href="function.mssql-free-statement.php" class="function" rel="rdfs-seeAlso">mssql_free_statement()</a> - Free statement memory</li>
<li class="member"><a href="function.mssql-init.php" class="function" rel="rdfs-seeAlso">mssql_init()</a> - Initializes a stored procedure or a remote stored procedure</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
