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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. -->
<refentry id="function.win32-create-service">
<refnamediv>
<refname>win32_create_service</refname>
<refpurpose>Creates a new service entry in the SCM database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>win32_create_service</methodname>
<methodparam><type>array</type><parameter>details</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>machine</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>details</parameter></term>
<listitem>
<para>
An array of service details:
<variablelist>
<varlistentry>
<term><parameter>service</parameter></term>
<listitem>
<para>
The short name of the service. This is the name that you
will use to control the service using the <literal>net</literal>
command. The service must be unique (no two services can share the
same name), and, ideally, should avoid having spaces in the name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>display</parameter></term>
<listitem>
<para>The display name of the service. This is the name that you
will see in the Services Applet.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The name of the user account under which you want the service to
run. If omitted, the service will run as the LocalSystem account.
If the username is specified, you must also provide a password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password that corresponds to the <parameter>user</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
The full path to the executable module that will be launched when
the service is started. If omitted, the path to the current PHP
process will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>params</parameter></term>
<listitem>
<para>
Command line parameters to pass to the service when it starts.
If you want to run a PHP script as the service, then the first
parameter should be the full path to the PHP script that you intend
to run.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>load_order</parameter></term>
<listitem>
<para>
Controls the load_order. This is not yet fully supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>svc_type</parameter></term>
<listitem>
<para>
Sets the service type. If omitted, the default value is
<constant>WIN32_SERVICE_WIN32_OWN_PROCESS</constant>.
Don't change this unless you know what you're doing.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start_type</parameter></term>
<listitem>
<para>
Specifies how the service should be started. The default is
<constant>WIN32_SERVICE_AUTO_START</constant> which means the the
service will be launched when the machine starts up.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>error_control</parameter></term>
<listitem>
<para>
Informs the SCM what it should do when it detects a problem with
the service. The default is
<constant>WIN32_SERVER_ERROR_IGNORE</constant>. Changing this
value is not yet fully supported.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>machine</parameter></term>
<listitem>
<para>
The optional machine name on which you want to create a service.
If omitted, it will use the local machine.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success, otherwise returns a win32 error code.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>win32_create_service</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<programlisting role="php">
<![CDATA[
<?php
$x = win32_create_service(array(
'service' => 'dummyphp',
'display' => 'sample dummy PHP service',
'params' => __FILE__ . ' run',
));
debug_zval_dump($x);
?>
]]>
</programlisting>
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>win32_delete_service</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
-->
|
