Commit 0669a224f588f1de451ff5f3686772cfaf3c7161

Sam Lantinga 2015-05-28T08:41:07

Fixed bug 2860 - SetProp must be paired with RemoveProp especially for properties added to external windows Coriiander Upon creating a window, a window property is added to it through the Win32-function "SetProp". This is done in the SDL-function "SetupWindowData" in file "src\video\windows\SDL_windowswindow.c". Whenever you call "SetProp" to add a property to a Win32-window, you should also call the Win32-function "RemoveProp" to remove it before destroying that Win32-window. While you might think that it's ok and that Windows will clean up nicely itself, it is not ok. It is against all Win32-API guidelines and is mostlikely a leak. Especially on external windows (CreateWindowFrom) you want to have things done right, not messy and leaky, affecting some other module. Even if SDL gets shutdown entirely that external window will now forever still have the "SDL_WindowData" prop attached to it.

1
2
3
4
5
6
7
8
9
10
11
12
diff --git a/src/video/windows/SDL_windowswindow.c b/src/video/windows/SDL_windowswindow.c
index e6b1bb0..5d3260e 100644
--- a/src/video/windows/SDL_windowswindow.c
+++ b/src/video/windows/SDL_windowswindow.c
@@ -615,6 +615,7 @@ WIN_DestroyWindow(_THIS, SDL_Window * window)
 
     if (data) {
         ReleaseDC(data->hwnd, data->hdc);
+        ReleaseProp(data->hwnd, TEXT("SDL_WindowData"));
         if (data->created) {
             DestroyWindow(data->hwnd);
         } else {