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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 #define SERVICE_CONTROL_SESSIONCHANGE         0x0000000E
  56
  57 /* Service State */
  58 #define SERVICE_STOPPED          0x00000001
  59 #define SERVICE_START_PENDING    0x00000002
  60 #define SERVICE_STOP_PENDING     0x00000003
  61 #define SERVICE_RUNNING          0x00000004
  62 #define SERVICE_CONTINUE_PENDING 0x00000005
  63 #define SERVICE_PAUSE_PENDING    0x00000006
  64 #define SERVICE_PAUSED           0x00000007
  65
  66 /* Controls Accepted */
  67 #define SERVICE_ACCEPT_STOP                  0x00000001
  68 #define SERVICE_ACCEPT_PAUSE_CONTINUE        0x00000002
  69 #define SERVICE_ACCEPT_SHUTDOWN              0x00000004
  70 #define SERVICE_ACCEPT_PARAMCHANGE           0x00000008
  71 #define SERVICE_ACCEPT_NETBINDCHANGE         0x00000010
  72 #define SERVICE_ACCEPT_HARDWAREPROFILECHANGE 0x00000020
  73 #define SERVICE_ACCEPT_POWEREVENT            0x00000040
  74 #define SERVICE_ACCEPT_SESSIONCHANGE         0x00000080
  75
  76 /* Service Control Manager Object access types */
  77 #define SC_MANAGER_CONNECT            0x0001
  78 #define SC_MANAGER_CREATE_SERVICE     0x0002
  79 #define SC_MANAGER_ENUMERATE_SERVICE  0x0004
  80 #define SC_MANAGER_LOCK               0x0008
  81 #define SC_MANAGER_QUERY_LOCK_STATUS  0x0010
  82 #define SC_MANAGER_MODIFY_BOOT_CONFIG 0x0020
  83 #define SC_MANAGER_ALL_ACCESS         ( STANDARD_RIGHTS_REQUIRED      | \
  84                                         SC_MANAGER_CONNECT            | \
  85                                         SC_MANAGER_CREATE_SERVICE     | \
  86                                         SC_MANAGER_ENUMERATE_SERVICE  | \
  87                                         SC_MANAGER_LOCK               | \
  88                                         SC_MANAGER_QUERY_LOCK_STATUS  | \
  89                                         SC_MANAGER_MODIFY_BOOT_CONFIG )
  90
  91 #define SERVICE_QUERY_CONFIG         0x0001
  92 #define SERVICE_CHANGE_CONFIG        0x0002
  93 #define SERVICE_QUERY_STATUS         0x0004
  94 #define SERVICE_ENUMERATE_DEPENDENTS 0x0008
  95 #define SERVICE_START                0x0010
  96 #define SERVICE_STOP                 0x0020
  97 #define SERVICE_PAUSE_CONTINUE       0x0040
  98 #define SERVICE_INTERROGATE          0x0080
  99 #define SERVICE_USER_DEFINED_CONTROL 0x0100
 100
 101 #define SERVICE_ALL_ACCESS           ( STANDARD_RIGHTS_REQUIRED     | \
 102                                        SERVICE_QUERY_CONFIG         | \
 103                                        SERVICE_CHANGE_CONFIG        | \
 104                                        SERVICE_QUERY_STATUS         | \
 105                                        SERVICE_ENUMERATE_DEPENDENTS | \
 106                                        SERVICE_START                | \
 107                                        SERVICE_STOP                 | \
 108                                        SERVICE_PAUSE_CONTINUE       | \
 109                                        SERVICE_INTERROGATE          | \
 110                                        SERVICE_USER_DEFINED_CONTROL )
 111
 112 #define SERVICE_NO_CHANGE 0xffffffff
 113
 114
 115 /* Handle types */
 116
 117 DECLARE_HANDLE(SC_HANDLE);
 118 typedef SC_HANDLE *LPSC_HANDLE;
 119 DECLARE_HANDLE(SERVICE_STATUS_HANDLE);
 120 typedef LPVOID SC_LOCK;
 121
 122 /* Service status structure */
 123
 124 typedef struct _SERVICE_STATUS {
 125   DWORD dwServiceType;
 126   DWORD dwCurrentState;
 127   DWORD dwControlsAccepted;
 128   DWORD dwWin32ExitCode;
 129   DWORD dwServiceSpecificExitCode;
 130   DWORD dwCheckPoint;
 131   DWORD dwWaitHint;
 132 } SERVICE_STATUS, *LPSERVICE_STATUS;
 133
 134 /* Service status process structure */
 135
 136 typedef struct _SERVICE_STATUS_PROCESS
 137 {
 138   DWORD dwServiceType;
 139   DWORD dwCurrentState;
 140   DWORD dwControlsAccepted;
 141   DWORD dwWin32ExitCode;
 142   DWORD dwServiceSpecificExitCode;
 143   DWORD dwCheckPoint;
 144   DWORD dwWaitHint;
 145   DWORD dwProcessId;
 146   DWORD dwServiceFlags;
 147 } SERVICE_STATUS_PROCESS, *LPSERVICE_STATUS_PROCESS;
 148
 149 typedef enum _SC_STATUS_TYPE {
 150   SC_STATUS_PROCESS_INFO      = 0
 151 } SC_STATUS_TYPE;
 152
 153 /* Service main function prototype */
 154
 155 typedef VOID (CALLBACK *LPSERVICE_MAIN_FUNCTIONA)(DWORD,LPSTR*);
 156 typedef VOID (CALLBACK *LPSERVICE_MAIN_FUNCTIONW)(DWORD,LPWSTR*);
 157 DECL_WINELIB_TYPE_AW(LPSERVICE_MAIN_FUNCTION)
 158
 159 /* Service start table */
 160
 161 typedef struct _SERVICE_TABLE_ENTRYA {
 162     LPSTR                    lpServiceName;
 163     LPSERVICE_MAIN_FUNCTIONA lpServiceProc;
 164 } SERVICE_TABLE_ENTRYA, *LPSERVICE_TABLE_ENTRYA;
 165
 166 typedef struct _SERVICE_TABLE_ENTRYW {
 167   LPWSTR                   lpServiceName;
 168   LPSERVICE_MAIN_FUNCTIONW lpServiceProc;
 169 } SERVICE_TABLE_ENTRYW, *LPSERVICE_TABLE_ENTRYW;
 170
 171 DECL_WINELIB_TYPE_AW(SERVICE_TABLE_ENTRY)
 172 DECL_WINELIB_TYPE_AW(LPSERVICE_TABLE_ENTRY)
 173
 174 /* Service status enumeration structure */
 175
 176 typedef struct _ENUM_SERVICE_STATUSA {
 177   LPSTR          lpServiceName;
 178   LPSTR          lpDisplayName;
 179   SERVICE_STATUS ServiceStatus;
 180 } ENUM_SERVICE_STATUSA, *LPENUM_SERVICE_STATUSA;
 181
 182 typedef struct _ENUM_SERVICE_STATUSW {
 183     LPWSTR         lpServiceName;
 184     LPWSTR         lpDisplayName;
 185     SERVICE_STATUS ServiceStatus;
 186 } ENUM_SERVICE_STATUSW, *LPENUM_SERVICE_STATUSW;
 187
 188 DECL_WINELIB_TYPE_AW(ENUM_SERVICE_STATUS)
 189 DECL_WINELIB_TYPE_AW(LPENUM_SERVICE_STATUS)
 190
 191 typedef struct _ENUM_SERVICE_STATUS_PROCESSA {
 192   LPSTR          lpServiceName;
 193   LPSTR          lpDisplayName;
 194   SERVICE_STATUS_PROCESS ServiceStatusProcess;
 195 } ENUM_SERVICE_STATUS_PROCESSA, *LPENUM_SERVICE_STATUS_PROCESSA;
 196
 197 typedef struct _ENUM_SERVICE_STATUS_PROCESSW {
 198     LPWSTR         lpServiceName;
 199     LPWSTR         lpDisplayName;
 200     SERVICE_STATUS_PROCESS ServiceStatusProcess;
 201 } ENUM_SERVICE_STATUS_PROCESSW, *LPENUM_SERVICE_STATUS_PROCESSW;
 202
 203 DECL_WINELIB_TYPE_AW(ENUM_SERVICE_STATUS_PROCESS)
 204 DECL_WINELIB_TYPE_AW(LPENUM_SERVICE_STATUS_PROCESS)
 205
 206 typedef enum _SC_ENUM_TYPE {
 207     SC_ENUM_PROCESS_INFO      = 0
 208 } SC_ENUM_TYPE;
 209
 210 typedef struct _QUERY_SERVICE_CONFIGA {
 211     DWORD   dwServiceType;
 212     DWORD   dwStartType;
 213     DWORD   dwErrorControl;
 214     LPSTR   lpBinaryPathName;
 215     LPSTR   lpLoadOrderGroup;
 216     DWORD   dwTagId;
 217     LPSTR   lpDependencies;
 218     LPSTR   lpServiceStartName;
 219     LPSTR   lpDisplayName;
 220 } QUERY_SERVICE_CONFIGA, *LPQUERY_SERVICE_CONFIGA;
 221
 222 typedef struct _QUERY_SERVICE_CONFIGW {
 223     DWORD   dwServiceType;
 224     DWORD   dwStartType;
 225     DWORD   dwErrorControl;
 226     LPWSTR  lpBinaryPathName;
 227     LPWSTR  lpLoadOrderGroup;
 228     DWORD   dwTagId;
 229     LPWSTR  lpDependencies;
 230     LPWSTR  lpServiceStartName;
 231     LPWSTR  lpDisplayName;
 232 } QUERY_SERVICE_CONFIGW, *LPQUERY_SERVICE_CONFIGW;
 233
 234 /* defines and structures for ChangeServiceConfig2 */
 235 #define SERVICE_CONFIG_DESCRIPTION     1
 236 #define SERVICE_CONFIG_FAILURE_ACTIONS 2
 237
 238 typedef struct _SERVICE_DESCRIPTIONA {
 239    LPSTR lpDescription;
 240 } SERVICE_DESCRIPTIONA,*LPSERVICE_DESCRIPTIONA;
 241
 242 typedef struct _SERVICE_DESCRIPTIONW {
 243    LPWSTR lpDescription;
 244 } SERVICE_DESCRIPTIONW,*LPSERVICE_DESCRIPTIONW;
 245
 246 DECL_WINELIB_TYPE_AW(SERVICE_DESCRIPTION)
 247 DECL_WINELIB_TYPE_AW(LPSERVICE_DESCRIPTION)
 248
 249 typedef enum _SC_ACTION_TYPE {
 250     SC_ACTION_NONE        = 0,
 251     SC_ACTION_RESTART     = 1,
 252     SC_ACTION_REBOOT      = 2,
 253     SC_ACTION_RUN_COMMAND = 3
 254 } SC_ACTION_TYPE;
 255
 256 typedef struct _SC_ACTION {
 257    SC_ACTION_TYPE  Type;
 258    DWORD       Delay;
 259 } SC_ACTION,*LPSC_ACTION;
 260
 261 typedef struct _SERVICE_FAILURE_ACTIONSA {
 262    DWORD   dwResetPeriod;
 263    LPSTR   lpRebootMsg;
 264    LPSTR   lpCommand;
 265    DWORD   cActions;
 266    SC_ACTION * lpsaActions;
 267 } SERVICE_FAILURE_ACTIONSA,*LPSERVICE_FAILURE_ACTIONSA;
 268
 269 typedef struct _SERVICE_FAILURE_ACTIONSW {
 270    DWORD   dwResetPeriod;
 271    LPWSTR  lpRebootMsg;
 272    LPWSTR  lpCommand;
 273    DWORD   cActions;
 274    SC_ACTION * lpsaActions;
 275 } SERVICE_FAILURE_ACTIONSW,*LPSERVICE_FAILURE_ACTIONSW;
 276
 277 DECL_WINELIB_TYPE_AW(SERVICE_FAILURE_ACTIONS)
 278 DECL_WINELIB_TYPE_AW(LPSERVICE_FAILURE_ACTIONS)
 279
 280 typedef struct _QUERY_SERVICE_LOCK_STATUSA
 281 {
 282   DWORD fIsLocked;
 283   LPSTR lpLockOwner;
 284   DWORD dwLockDuration;
 285 } QUERY_SERVICE_LOCK_STATUSA, *LPQUERY_SERVICE_LOCK_STATUSA;
 286
 287 typedef struct _QUERY_SERVICE_LOCK_STATUSW
 288 {
 289   DWORD fIsLocked;
 290   LPWSTR lpLockOwner;
 291   DWORD dwLockDuration;
 292 } QUERY_SERVICE_LOCK_STATUSW, *LPQUERY_SERVICE_LOCK_STATUSW;
 293
 294 DECL_WINELIB_TYPE_AW(QUERY_SERVICE_LOCK_STATUS)
 295
 296 /* Service control handler function prototype */
 297
 298 typedef VOID (WINAPI *LPHANDLER_FUNCTION)(DWORD);
 299 typedef DWORD (WINAPI *LPHANDLER_FUNCTION_EX)(DWORD,DWORD,LPVOID,LPVOID);
 300
 301 /* API function prototypes */
 302
 303 BOOL        WINAPI ChangeServiceConfigA(SC_HANDLE,DWORD,DWORD,DWORD,LPCSTR,LPCSTR,LPDWORD,LPCSTR,LPCSTR,LPCSTR,LPCSTR);
 304 BOOL        WINAPI ChangeServiceConfigW(SC_HANDLE,DWORD,DWORD,DWORD,LPCWSTR,LPCWSTR,LPDWORD,LPCWSTR,LPCWSTR,LPCWSTR,LPCWSTR);
 305 #define     ChangeServiceConfig WINELIB_NAME_AW(ChangeServiceConfig)
 306 BOOL        WINAPI ChangeServiceConfig2A(SC_HANDLE,DWORD,LPVOID);
 307 BOOL        WINAPI ChangeServiceConfig2W(SC_HANDLE,DWORD,LPVOID);
 308 #define     ChangeServiceConfig2 WINELIB_NAME_AW(ChangeServiceConfig2)
 309 BOOL        WINAPI CloseServiceHandle(SC_HANDLE);
 310 BOOL        WINAPI ControlService(SC_HANDLE,DWORD,LPSERVICE_STATUS);
 311 SC_HANDLE   WINAPI CreateServiceA(SC_HANDLE,LPCSTR,LPCSTR,DWORD,DWORD,DWORD,DWORD,LPCSTR,
 312                                   LPCSTR,LPDWORD,LPCSTR,LPCSTR,LPCSTR);
 313 SC_HANDLE   WINAPI CreateServiceW(SC_HANDLE,LPCWSTR,LPCWSTR,DWORD,DWORD,DWORD,DWORD,LPCWSTR,
 314                                   LPCWSTR,LPDWORD,LPCWSTR,LPCWSTR,LPCWSTR);
 315 #define     CreateService WINELIB_NAME_AW(CreateService)
 316 BOOL        WINAPI DeleteService(SC_HANDLE);
 317 BOOL        WINAPI EnumDependentServicesA(SC_HANDLE,DWORD,LPENUM_SERVICE_STATUSA,DWORD,LPDWORD,LPDWORD);
 318 BOOL        WINAPI EnumDependentServicesW(SC_HANDLE,DWORD,LPENUM_SERVICE_STATUSW,DWORD,LPDWORD,LPDWORD);
 319 #define     EnumDependentServices WINELIB_NAME_AW(EnumDependentServices)
 320 BOOL        WINAPI EnumServicesStatusA(SC_HANDLE,DWORD,DWORD,LPENUM_SERVICE_STATUSA,
 321                                        DWORD,LPDWORD,LPDWORD,LPDWORD);
 322 BOOL        WINAPI EnumServicesStatusW(SC_HANDLE,DWORD,DWORD,LPENUM_SERVICE_STATUSW,
 323                                        DWORD,LPDWORD,LPDWORD,LPDWORD);
 324 #define     EnumServicesStatus WINELIB_NAME_AW(EnumServicesStatus)
 325 BOOL        WINAPI EnumServicesStatusExA(SC_HANDLE,SC_ENUM_TYPE,DWORD,DWORD,LPBYTE,
 326                                          DWORD,LPDWORD,LPDWORD,LPDWORD,LPCSTR);
 327 BOOL        WINAPI EnumServicesStatusExW(SC_HANDLE,SC_ENUM_TYPE,DWORD,DWORD,LPBYTE,
 328                                          DWORD,LPDWORD,LPDWORD,LPDWORD,LPCWSTR);
 329 #define     EnumServicesStatus WINELIB_NAME_AW(EnumServicesStatus)
 330 BOOL        WINAPI GetServiceDisplayNameA(SC_HANDLE,LPCSTR,LPSTR,LPDWORD);
 331 BOOL        WINAPI GetServiceDisplayNameW(SC_HANDLE,LPCWSTR,LPWSTR,LPDWORD);
 332 #define     GetServiceDisplayName WINELIB_NAME_AW(GetServiceDisplayName)
 333 BOOL        WINAPI GetServiceKeyNameA(SC_HANDLE,LPCSTR,LPSTR,LPDWORD);
 334 BOOL        WINAPI GetServiceKeyNameW(SC_HANDLE,LPCWSTR,LPWSTR,LPDWORD);
 335 #define     GetServiceKeyName WINELIB_NAME_AW(GetServiceKeyName)
 336 SC_LOCK     WINAPI LockServiceDatabase(SC_HANDLE);
 337 BOOL        WINAPI NotifyBootConfigStatus(BOOL);
 338 SC_HANDLE   WINAPI OpenSCManagerA(LPCSTR,LPCSTR,DWORD);
 339 SC_HANDLE   WINAPI OpenSCManagerW(LPCWSTR,LPCWSTR,DWORD);
 340 #define     OpenSCManager WINELIB_NAME_AW(OpenSCManager)
 341 SC_HANDLE   WINAPI OpenServiceA(SC_HANDLE,LPCSTR,DWORD);
 342 SC_HANDLE   WINAPI OpenServiceW(SC_HANDLE,LPCWSTR,DWORD);
 343 #define     OpenService WINELIB_NAME_AW(OpenService)
 344 BOOL        WINAPI QueryServiceStatus(SC_HANDLE,LPSERVICE_STATUS);
 345 BOOL        WINAPI QueryServiceStatusEx(SC_HANDLE,SC_STATUS_TYPE,LPBYTE,DWORD,LPDWORD);
 346 BOOL        WINAPI QueryServiceConfigA(SC_HANDLE,LPQUERY_SERVICE_CONFIGA,DWORD,LPDWORD);
 347 BOOL        WINAPI QueryServiceConfigW(SC_HANDLE,LPQUERY_SERVICE_CONFIGW,DWORD,LPDWORD);
 348 #define     QueryServiceConfig WINELIB_NAME_AW(QueryServiceConfig)
 349 BOOL        WINAPI QueryServiceLockStatusA(SC_HANDLE,LPQUERY_SERVICE_LOCK_STATUSA,DWORD,LPDWORD);
 350 BOOL        WINAPI QueryServiceLockStatusW(SC_HANDLE,LPQUERY_SERVICE_LOCK_STATUSW,DWORD,LPDWORD);
 351 #define     QueryServiceLockStatus WINELIB_NAME_AW(QueryServiceLockStatus)
 352 BOOL        WINAPI QueryServiceObjectSecurity(SC_HANDLE,SECURITY_INFORMATION,PSECURITY_DESCRIPTOR,DWORD,LPDWORD);
 353 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerA(LPCSTR,LPHANDLER_FUNCTION);
 354 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerW(LPCWSTR,LPHANDLER_FUNCTION);
 355 #define     RegisterServiceCtrlHandler WINELIB_NAME_AW(RegisterServiceCtrlHandler)
 356 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerExA(LPCSTR,LPHANDLER_FUNCTION_EX,LPVOID);
 357 SERVICE_STATUS_HANDLE WINAPI RegisterServiceCtrlHandlerExW(LPCWSTR,LPHANDLER_FUNCTION_EX,LPVOID);
 358 #define     RegisterServiceCtrlHandlerEx WINELIB_NAME_AW(RegisterServiceCtrlHandlerEx)
 359 BOOL        WINAPI SetServiceObjectSecurity(SC_HANDLE,SECURITY_INFORMATION,PSECURITY_DESCRIPTOR);
 360 BOOL        WINAPI SetServiceStatus(SERVICE_STATUS_HANDLE,LPSERVICE_STATUS);
 361 BOOL        WINAPI StartServiceA(SC_HANDLE,DWORD,LPCSTR*);
 362 BOOL        WINAPI StartServiceW(SC_HANDLE,DWORD,LPCWSTR*);
 363 #define     StartService WINELIB_NAME_AW(StartService)
 364 BOOL        WINAPI StartServiceCtrlDispatcherA(const SERVICE_TABLE_ENTRYA*);
 365 BOOL        WINAPI StartServiceCtrlDispatcherW(const SERVICE_TABLE_ENTRYW*);
 366 #define     StartServiceCtrlDispatcher WINELIB_NAME_AW(StartServiceCtrlDispatcher)
 367 BOOL        WINAPI UnlockServiceDatabase(SC_LOCK);
 368
 369 #ifdef __cplusplus
 370 } /* extern "C" */
 371 #endif /* defined(__cplusplus) */
 372
 373 #endif /* !defined(__WINE_WINSVC_H) */