Understanding the Locking Issue
When a Windows Service is running, the operating system loads the executable into memory and maintains a handle to the file. If InnoSetup attempts to delete these files while the service is active, the operation fails with an "Access Denied" or "File in Use" error. This is a standard security feature in Windows to prevent accidental deletion of critical system components.
The core problem lies in the sequence of events within the [UninstallRun] or [Code] section of your InnoSetup script. If the script tries to delete files before stopping the service, the uninstaller will hang or fail. You must explicitly manage the service lifecycle using Windows API calls or command-line tools within the installation script.
Why Standard Deletion Fails
- Exclusive Handles: The Service Control Manager (SCM) locks the binary path.
- Delayed Termination: Even after sending a stop signal, the process may take time to terminate completely.
- Dependencies: Other services might depend on the service being removed, preventing immediate deletion.
Solution: Stopping the Service via Script
The most robust way to handle this is by writing Pascal Script code in InnoSetup to interact with the Windows Service Controller. This approach gives you precise control over the state transitions of the service.
First, you need to define a function that stops the service. You can use the CreateService and ControlService APIs from the Windows API, but it is often easier to use the built-in Exec function to run the net stop command. However, for a cleaner integration, we recommend using the WinApi functions directly if you are comfortable with Pascal scripting.
function StopService(ServiceName: String): Boolean;
var
ServiceCtrlMgr, ServiceHandle: LongInt;
ServiceStatus: TServiceStatus;
begin
Result := False;
ServiceCtrlMgr := OpenSCManager(nil, nil, SC_MANAGER_CONNECT);
if ServiceCtrlMgr <> 0 then
begin
ServiceHandle := OpenService(ServiceCtrlMgr, PChar(ServiceName), SERVICE_STOP);
if ServiceHandle <> 0 then
begin
if ControlService(ServiceHandle, SERVICE_CONTROL_STOP, ServiceStatus) then
begin
// Wait for the service to actually stop
while ServiceStatus.dwCurrentState = SERVICE_STOP_PENDING do
begin
Sleep(100);
ControlService(ServiceHandle, SERVICE_CONTROL_STOP, ServiceStatus);
end;
Result := True;
end;
CloseServiceHandle(ServiceHandle);
end;
CloseServiceHandle(ServiceCtrlMgr);
end;
end;Insert this code into the [Code] section of your .iss file. Then, call this function in the CurStepChanged(csUninstall) event before deleting any files.
Alternative: Using Command Line Tools
If you prefer not to write custom Pascal code, you can execute the sc.exe or net.exe commands directly. This method is less elegant but easier to implement for simple scripts.
procedure CurStepChanged(CurStep: TSetupStep);
begin
if CurStep = csUninstall then
begin
if Exec('sc.exe', 'stop MyService', '', SW_HIDE, ewWaitUntilTerminated, ReturnCode) then
begin
// Service stopped successfully
end;
end;
end;Note that sc.exe requires administrative privileges. Ensure your installer is configured to request elevation. Also, verify that the service name matches exactly what is registered in the registry under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services.
Handling Registry Cleanup
After stopping the service, you should also remove its registry entries to ensure a complete uninstallation. InnoSetup provides the DeleteRegKey function for this purpose.
DeleteRegKey(HKLM, 'SYSTEM\CurrentControlSet\Services\MyService');Always back up the registry key before deletion if there is any chance of needing to restore it. However, for a full uninstall, removal is appropriate. Be cautious when deleting keys related to other applications to avoid breaking shared configurations.
Best Practices for Robust Uninstallation
- Check Service Status: Before stopping, check if the service exists and is running. Not all users may have started the service.
- Timeout Handling: Implement a timeout loop. If the service does not stop within 30 seconds, force termination or log an error.
- Error Logging: Write errors to a log file so users can report issues if the uninstallation fails.
For more information on handling file permissions during uninstallation, you might find Windows Updates May Cause Unavailability of Certain Files for Java Applications Running as Windows Service on Non-Privileged Account helpful, as it discusses similar permission and locking issues.
Frequently Asked Questions
What happens if the service refuses to stop?
If the service hangs, you may need to force terminate the process using the Task Manager or the taskkill command. However, this is generally discouraged as it can leave data in an inconsistent state. Always try graceful shutdown first.
Do I need administrator rights to stop a service?
Yes, stopping and removing Windows services requires elevated privileges. Your InnoSetup installer must be configured to request UAC elevation using the PrivilegesRequired=admin directive in the [Setup] section.
Can I delete the service key without stopping the service?
No, deleting the registry key while the service is running will cause the service to crash upon next restart or may prevent it from starting entirely. Always stop the service before modifying its registry configuration.
How do I know if my service has stopped completely?
You can check the dwCurrentState field in the TServiceStatus structure. It should equal SERVICE_STOPPED. If it remains SERVICE_STOP_PENDING, continue waiting or consider forcing termination.
Is it safe to delete the service files immediately after stopping?
It is usually safe, but adding a small delay (e.g., 500 milliseconds) between stopping the service and deleting files can help ensure all file handles are released by the OS.