Added some extra functions.
[wine] / include / winsvc.h
1 /*
2  * Copyright (C) the Wine project
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #ifndef __WINE_WINSVC_H
20 #define __WINE_WINSVC_H
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif /* defined(__cplusplus) */
25
26 /* Service database names */
27 #define SERVICES_ACTIVE_DATABASEA     "ServicesActive"
28 #define SERVICES_FAILED_DATABASEA     "ServicesFailed"
29
30 #if defined(__GNUC__)
31 # define SERVICES_ACTIVE_DATABASEW    (const WCHAR []){ 'S','e','r','v','i','c','e','s','A','c','t','i','v','e',0 }
32 # define SERVICES_FAILED_DATABASEW    (const WCHAR []){ 'S','e','r','v','i','c','e','s','F','a','i','l','e','d',0 }
33 #elif defined(_MSC_VER)
34 # define SERVICES_ACTIVE_DATABASEW    L"ServicesActive"
35 # define SERVICES_FAILED_DATABASEW    L"ServicesFailed"
36 #endif
37
38 #define SERVICES_ACTIVE_DATABASE      WINELIB_NAME_AW( SERVICES_ACTIVE_DATABASE )
39 #define SERVICES_FAILED_DATABASE      WINELIB_NAME_AW( SERVICES_FAILED_DATABASE )
40
41 /* Controls */
42 #define SERVICE_CONTROL_STOP                  0x00000001
43 #define SERVICE_CONTROL_PAUSE                 0x00000002
44 #define SERVICE_CONTROL_CONTINUE              0x00000003
45 #define SERVICE_CONTROL_INTERROGATE           0x00000004
46 #define SERVICE_CONTROL_SHUTDOWN              0x00000005
47 #define SERVICE_CONTROL_PARAMCHANGE           0x00000006
48 #define SERVICE_CONTROL_NETBINDADD            0x00000007
49 #define SERVICE_CONTROL_NETBINDREMOVE         0x00000008
50 #define SERVICE_CONTROL_NETBINDENABLE         0x00000009
51 #define SERVICE_CONTROL_NETBINDDISABLE        0x0000000A
52 #define SERVICE_CONTROL_DEVICEEVENT           0x0000000B
53 #define SERVICE_CONTROL_HARDWAREPROFILECHANGE 0x0000000C
54 #define SERVICE_CONTROL_POWEREVENT            0x0000000D
55
56 /* Service State */
57 #define SERVICE_STOPPED          0x00000001
58 #define SERVICE_START_PENDING    0x00000002
59 #define SERVICE_STOP_PENDING     0x00000003
60 #define SERVICE_RUNNING          0x00000004
61 #define SERVICE_CONTINUE_PENDING 0x00000005
62 #define SERVICE_PAUSE_PENDING    0x00000006
63 #define SERVICE_PAUSED           0x00000007
64
65 /* Controls Accepted */
66 #define SERVICE_ACCEPT_STOP                  0x00000001
67 #define SERVICE_ACCEPT_PAUSE_CONTINUE        0x00000002
68 #define SERVICE_ACCEPT_SHUTDOWN              0x00000004
69 #define SERVICE_ACCEPT_PARAMCHANGE           0x00000008
70 #define SERVICE_ACCEPT_NETBINDCHANGE         0x00000010
71 #define SERVICE_ACCEPT_HARDWAREPROFILECHANGE 0x00000020
72 #define SERVICE_ACCEPT_POWEREVENT            0x00000040
73
74 /* Service Control Manager Object access types */
75 #define SC_MANAGER_CONNECT            0x0001
76 #define SC_MANAGER_CREATE_SERVICE     0x0002
77 #define SC_MANAGER_ENUMERATE_SERVICE  0x0004
78 #define SC_MANAGER_LOCK               0x0008
79 #define SC_MANAGER_QUERY_LOCK_STATUS  0x0010
80 #define SC_MANAGER_MODIFY_BOOT_CONFIG 0x0020
81 #define SC_MANAGER_ALL_ACCESS         ( STANDARD_RIGHTS_REQUIRED      | \
82                                         SC_MANAGER_CONNECT            | \
83                                         SC_MANAGER_CREATE_SERVICE     | \
84                                         SC_MANAGER_ENUMERATE_SERVICE  | \
85                                         SC_MANAGER_LOCK               | \
86                                         SC_MANAGER_QUERY_LOCK_STATUS  | \
87                                         SC_MANAGER_MODIFY_BOOT_CONFIG )
88
89 #define SERVICE_QUERY_CONFIG         0x0001
90 #define SERVICE_CHANGE_CONFIG        0x0002
91 #define SERVICE_QUERY_STATUS         0x0004
92 #define SERVICE_ENUMERATE_DEPENDENTS 0x0008
93 #define SERVICE_START                0x0010
94 #define SERVICE_STOP                 0x0020
95 #define SERVICE_PAUSE_CONTINUE       0x0040
96 #define SERVICE_INTERROGATE          0x0080
97 #define SERVICE_USER_DEFINED_CONTROL 0x0100
98
99 #define SERVICE_ALL_ACCESS           ( STANDARD_RIGHTS_REQUIRED     | \
100                                        SERVICE_QUERY_CONFIG         | \
101                                        SERVICE_CHANGE_CONFIG        | \
102                                        SERVICE_QUERY_STATUS         | \
103                                        SERVICE_ENUMERATE_DEPENDENTS | \
104                                        SERVICE_START                | \
105                                        SERVICE_STOP                 | \
106                                        SERVICE_PAUSE_CONTINUE       | \
107                                        SERVICE_INTERROGATE          | \
108                                        SERVICE_USER_DEFINED_CONTROL )
109
110 #define SERVICE_NO_CHANGE 0xffffffff
111
112
113 /* Handle types */
114
115 typedef HANDLE SC_HANDLE, *LPSC_HANDLE;
116 typedef DWORD  SERVICE_STATUS_HANDLE;
117
118
119 /* Service status structure */
120
121 typedef struct _SERVICE_STATUS {
122   DWORD dwServiceType;
123   DWORD dwCurrentState;
124   DWORD dwControlsAccepted;
125   DWORD dwWin32ExitCode;
126   DWORD dwServiceSpecificExitCode;
127   DWORD dwCheckPoint;
128   DWORD dwWaitHint;
129 } SERVICE_STATUS, *LPSERVICE_STATUS;
130
131 typedef enum _SC_STATUS_TYPE {
132   SC_STATUS_PROCESS_INFO      = 0
133 } SC_STATUS_TYPE;
134
135 /* Service main function prototype */
136
137 typedef VOID (CALLBACK *LPSERVICE_MAIN_FUNCTIONA)(DWORD,LPSTR*);
138 typedef VOID (CALLBACK *LPSERVICE_MAIN_FUNCTIONW)(DWORD,LPWSTR*);
139 DECL_WINELIB_TYPE_AW(LPSERVICE_MAIN_FUNCTION)
140
141 /* Service start table */
142
143 typedef struct _SERVICE_TABLE_ENTRYA {
144     LPSTR                    lpServiceName;
145     LPSERVICE_MAIN_FUNCTIONA lpServiceProc;
146 } SERVICE_TABLE_ENTRYA, *LPSERVICE_TABLE_ENTRYA;
147
148 typedef struct _SERVICE_TABLE_ENTRYW {
149   LPWSTR                   lpServiceName;
150   LPSERVICE_MAIN_FUNCTIONW lpServiceProc;
151 } SERVICE_TABLE_ENTRYW, *LPSERVICE_TABLE_ENTRYW;
152
153 DECL_WINELIB_TYPE_AW(SERVICE_TABLE_ENTRY)
154 DECL_WINELIB_TYPE_AW(LPSERVICE_TABLE_ENTRY)
155
156 /* Service status enumeration structure */
157
158 typedef struct _ENUM_SERVICE_STATUSA {
159   LPSTR          lpServiceName;
160   LPSTR          lpDisplayName;
161   SERVICE_STATUS ServiceStatus;
162 } ENUM_SERVICE_STATUSA, *LPENUM_SERVICE_STATUSA;
163
164 typedef struct _ENUM_SERVICE_STATUSW {
165     LPWSTR         lpServiceName;
166     LPWSTR         lpDisplayName;
167     SERVICE_STATUS ServiceStatus;
168 } ENUM_SERVICE_STATUSW, *LPENUM_SERVICE_STATUSW;
169
170 DECL_WINELIB_TYPE_AW(ENUM_SERVICE_STATUS)
171 DECL_WINELIB_TYPE_AW(LPENUM_SERVICE_STATUS)
172
173 typedef struct _QUERY_SERVICE_CONFIGA {
174     DWORD   dwServiceType;
175     DWORD   dwStartType;
176     DWORD   dwErrorControl;
177     LPSTR   lpBinaryPathName;
178     LPSTR   lpLoadOrderGroup;
179     DWORD   dwTagId;
180     LPSTR   lpDependencies;
181     LPSTR   lpServiceStartName;
182     LPSTR   lpDisplayName;
183 } QUERY_SERVICE_CONFIGA, *LPQUERY_SERVICE_CONFIGA;
184
185 typedef struct _QUERY_SERVICE_CONFIGW {
186     DWORD   dwServiceType;
187     DWORD   dwStartType;
188     DWORD   dwErrorControl;
189     LPWSTR  lpBinaryPathName;
190     LPWSTR  lpLoadOrderGroup;
191     DWORD   dwTagId;
192     LPWSTR  lpDependencies;
193     LPWSTR  lpServiceStartName;
194     LPWSTR  lpDisplayName;
195 } QUERY_SERVICE_CONFIGW, *LPQUERY_SERVICE_CONFIGW;
196
197 /* defines and structures for ChangeServiceConfig2 */
198 #define SERVICE_CONFIG_DESCRIPTION     1
199 #define SERVICE_CONFIG_FAILURE_ACTIONS 2
200
201 typedef struct _SERVICE_DESCRIPTIONA {
202    LPSTR lpDescription;
203 } SERVICE_DESCRIPTIONA,*LPSERVICE_DESCRIPTIONA;
204
205 typedef struct _SERVICE_DESCRIPTIONW {
206    LPWSTR lpDescription;
207 } SERVICE_DESCRIPTIONW,*LPSERVICE_DESCRIPTIONW;
208
209 DECL_WINELIB_TYPE_AW(SERVICE_DESCRIPTION)
210 DECL_WINELIB_TYPE_AW(LPSERVICE_DESCRIPTION)
211
212 typedef enum _SC_ACTION_TYPE {
213     SC_ACTION_NONE        = 0,
214     SC_ACTION_RESTART     = 1,
215     SC_ACTION_REBOOT      = 2,
216     SC_ACTION_RUN_COMMAND = 3
217 } SC_ACTION_TYPE;
218
219 typedef struct _SC_ACTION {
220    SC_ACTION_TYPE  Type;
221    DWORD       Delay;
222 } SC_ACTION,*LPSC_ACTION;
223
224 typedef struct _SERVICE_FAILURE_ACTIONSA {
225    DWORD   dwResetPeriod;
226    LPSTR   lpRebootMsg;
227    LPSTR   lpCommand;
228    DWORD   cActions;
229    SC_ACTION * lpsaActions;
230 } SERVICE_FAILURE_ACTIONSA,*LPSERVICE_FAILURE_ACTIONSA;
231
232 typedef struct _SERVICE_FAILURE_ACTIONSW {
233    DWORD   dwResetPeriod;
234    LPWSTR  lpRebootMsg;
235    LPWSTR  lpCommand;
236    DWORD   cActions;
237    SC_ACTION * lpsaActions;
238 } SERVICE_FAILURE_ACTIONSW,*LPSERVICE_FAILURE_ACTIONSW;
239
240 DECL_WINELIB_TYPE_AW(SERVICE_FAILURE_ACTIONS)
241 DECL_WINELIB_TYPE_AW(LPSERVICE_FAILURE_ACTIONS)
242
243 typedef struct _QUERY_SERVICE_LOCK_STATUSA
244 {
245   DWORD fIsLocked;
246   LPSTR lpLockOwner;
247   DWORD dwLockDuration;
248 } QUERY_SERVICE_LOCK_STATUSA, *LPQUERY_SERVICE_LOCK_STATUSA;
249
250 typedef struct _QUERY_SERVICE_LOCK_STATUSW
251 {
252   DWORD fIsLocked;
253   LPWSTR lpLockOwner;
254   DWORD dwLockDuration;
255 } QUERY_SERVICE_LOCK_STATUSW, *LPQUERY_SERVICE_LOCK_STATUSW;
256
257 DECL_WINELIB_TYPE_AW(QUERY_SERVICE_LOCK_STATUS)
258
259 /* Service control handler function prototype */
260
261 typedef VOID (WINAPI *LPHANDLER_FUNCTION)(DWORD);
262 typedef DWORD (WINAPI *LPHANDLER_FUNCTION_EX)(DWORD,DWORD,LPVOID,LPVOID);
263
264 /* API function prototypes */
265
266 BOOL        WINAPI ChangeServiceConfigA(SC_HANDLE,DWORD,DWORD,DWORD,LPCSTR,LPCSTR,LPDWORD,LPCSTR,LPCSTR,LPCSTR,LPCSTR);
267 BOOL        WINAPI ChangeServiceConfigW(SC_HANDLE,DWORD,DWORD,DWORD,LPCWSTR,LPCWSTR,LPDWORD,LPCWSTR,LPCWSTR,LPCWSTR,LPCWSTR);
268 #define     ChangeServiceConfig WINELIB_NAME_AW(ChangeServiceConfig)
269 BOOL        WINAPI ChangeServiceConfig2A(SC_HANDLE,DWORD,LPVOID);
270 BOOL        WINAPI ChangeServiceConfig2W(SC_HANDLE,DWORD,LPVOID);
271 #define     ChangeServiceConfig2 WINELIB_NAME_AW(ChangeServiceConfig2)
272 BOOL        WINAPI CloseServiceHandle(SC_HANDLE);
273 BOOL        WINAPI ControlService(SC_HANDLE,DWORD,LPSERVICE_STATUS);
274 SC_HANDLE   WINAPI CreateServiceA(SC_HANDLE,LPCSTR,LPCSTR,DWORD,DWORD,DWORD,DWORD,LPCSTR,
275                                   LPCSTR,LPDWORD,LPCSTR,LPCSTR,LPCSTR);
276 SC_HANDLE   WINAPI CreateServiceW(SC_HANDLE,LPCWSTR,LPCWSTR,DWORD,DWORD,DWORD,DWORD,LPCWSTR,
277                                   LPCWSTR,LPDWORD,LPCWSTR,LPCWSTR,LPCWSTR);
278 #define     CreateService WINELIB_NAME_AW(CreateService)
279 BOOL        WINAPI DeleteService(SC_HANDLE);
280 BOOL        WINAPI EnumDependentServicesA(SC_HANDLE,DWORD,LPENUM_SERVICE_STATUSA,DWORD,LPDWORD,LPDWORD);
281 BOOL        WINAPI EnumDependentServicesW(SC_HANDLE,DWORD,LPENUM_SERVICE_STATUSW,DWORD,LPDWORD,LPDWORD);
282 #define     EnumDependentServices WINELIB_NAME_AW(EnumDependentServices)
283 BOOL        WINAPI EnumServicesStatusA(SC_HANDLE,DWORD,DWORD,LPENUM_SERVICE_STATUSA,
284                                        DWORD,LPDWORD,LPDWORD,LPDWORD);
285 BOOL        WINAPI EnumServicesStatusW(SC_HANDLE,DWORD,DWORD,LPENUM_SERVICE_STATUSW,
286                                        DWORD,LPDWORD,LPDWORD,LPDWORD);
287 #define     EnumServicesStatus WINELIB_NAME_AW(EnumServicesStatus)
288 BOOL        WINAPI GetServiceKeyNameA(SC_HANDLE,LPCSTR,LPSTR,LPDWORD);
289 BOOL        WINAPI GetServiceKeyNameW(SC_HANDLE,LPCWSTR,LPWSTR,LPDWORD);
290 #define     GetServiceKeyName WINELIB_NAME_AW(GetServiceKeyName)
291 SC_HANDLE   WINAPI OpenSCManagerA(LPCSTR,LPCSTR,DWORD);
292 SC_HANDLE   WINAPI OpenSCManagerW(LPCWSTR,LPCWSTR,DWORD);
293 #define     OpenSCManager WINELIB_NAME_AW(OpenSCManager)
294 SC_HANDLE   WINAPI OpenServiceA(SC_HANDLE,LPCSTR,DWORD);
295 SC_HANDLE   WINAPI OpenServiceW(SC_HANDLE,LPCWSTR,DWORD);
296 #define     OpenService WINELIB_NAME_AW(OpenService)
297 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerA(LPCSTR,LPHANDLER_FUNCTION);
298 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerW(LPCWSTR,LPHANDLER_FUNCTION);
299 #define     RegisterServiceCtrlHandler WINELIB_NAME_AW(RegisterServiceCtrlHandler)
300 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerExA(LPCSTR,LPHANDLER_FUNCTION_EX,LPVOID);
301 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerExW(LPCWSTR,LPHANDLER_FUNCTION_EX,LPVOID);
302 #define     RegisterServiceCtrlHandlerEx WINELIB_NAME_AW(RegisterServiceCtrlHandlerEx)
303 BOOL        WINAPI SetServiceStatus(SERVICE_STATUS_HANDLE,LPSERVICE_STATUS);
304 BOOL        WINAPI StartServiceA(SC_HANDLE,DWORD,LPCSTR*);
305 BOOL        WINAPI StartServiceW(SC_HANDLE,DWORD,LPCWSTR*);
306 #define     StartService WINELIB_NAME_AW(StartService)
307 BOOL        WINAPI StartServiceCtrlDispatcherA(LPSERVICE_TABLE_ENTRYA);
308 BOOL        WINAPI StartServiceCtrlDispatcherW(LPSERVICE_TABLE_ENTRYW);
309 #define     StartServiceCtrlDispatcher WINELIB_NAME_AW(StartServiceCtrlDispatcher)
310 BOOL        WINAPI QueryServiceStatus(SC_HANDLE,LPSERVICE_STATUS);
311 BOOL        WINAPI QueryServiceStatusEx(SC_HANDLE,SC_STATUS_TYPE,LPBYTE,DWORD,LPDWORD);
312 BOOL        WINAPI QueryServiceConfigA(SC_HANDLE,LPQUERY_SERVICE_CONFIGA,DWORD,LPDWORD);
313 BOOL        WINAPI QueryServiceConfigW(SC_HANDLE,LPQUERY_SERVICE_CONFIGW,DWORD,LPDWORD);
314 #define     QueryServiceConfig WINELIB_NAME_AW(QueryServiceConfig)
315 BOOL        WINAPI QueryServiceLockStatusA(SC_HANDLE,LPQUERY_SERVICE_LOCK_STATUSA,DWORD,LPDWORD);
316 BOOL        WINAPI QueryServiceLockStatusW(SC_HANDLE,LPQUERY_SERVICE_LOCK_STATUSW,DWORD,LPDWORD);
317 #define     QueryServiceLockStatus WINELIB_NAME_AW(QueryServiceLockStatus)
318
319 #ifdef __cplusplus
320 } /* extern "C" */
321 #endif /* defined(__cplusplus) */
322
323 #endif /* !defined(__WINE_WINSVC_H) */