1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<refentry xml:id='function.mssql-bind' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mssql_bind</refname>
<refpurpose>Adds a parameter to a stored procedure or a remote stored procedure</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>mssql_bind</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>string</type><parameter>param_name</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">var</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_output</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_null</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxlen</parameter></methodparam>
</methodsynopsis>
<para>
Binds a parameter to a stored procedure or a remote stored procedure.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stmt</parameter></term>
<listitem>
<para>
Statement resource, obtained with <function>mssql_init</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>param_name</parameter></term>
<listitem>
<para>
The parameter name, as a string.
</para>
<note>
<para>
You have to include the <literal>@</literal> character, like in the
T-SQL syntax. See the explanation included in
<function>mssql_execute</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem>
<para>
The PHP variable you'll bind the MSSQL parameter to. You can pass it
by value, or by reference, to retrieve OUTPUT and RETVAL values after
the procedure execution.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
One of: <constant>SQLTEXT</constant>,
<constant>SQLVARCHAR</constant>, <constant>SQLCHAR</constant>,
<constant>SQLINT1</constant>, <constant>SQLINT2</constant>,
<constant>SQLINT4</constant>, <constant>SQLBIT</constant>,
<constant>SQLFLT4</constant>, <constant>SQLFLT8</constant>,
<constant>SQLFLTN</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_output</parameter></term>
<listitem>
<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.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>is_null</parameter></term>
<listitem>
<para>
Whether the parameter is &null; or not. Passing the &null; value as
<parameter>var</parameter> will not do the job.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>maxlen</parameter></term>
<listitem>
<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
<constant>SQLVARCHAR</constant> and this value <literal>50</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mssql_bind</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Connect to MSSQL
mssql_connect('KALLESPC\SQLEXPRESS', 'sa', 'phpfi');
mssql_select_db('php');
// Create a new stored prodecure
$stmt = mssql_init('NewUserRecord');
// Bind the field names
mssql_bind($stmt, '@username', 'Kalle', SQLVARCHAR, false, false, 60);
mssql_bind($stmt, '@name', 'Kalle', SQLVARCHAR, false, false, 60);
mssql_bind($stmt, '@age', 19, SQLINT1, false, false, 3);
// Execute
mssql_execute($stmt);
// Free statement
mssql_free_statement($stmt);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mssql_execute</function></member>
<member><function>mssql_free_statement</function></member>
<member><function>mssql_init</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:"../../../../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
-->
|
