From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Tue, 26 Oct 2010 15:10:54 +0000 (+0000)
Subject: Better document wxAutomationObject::GetDispatchPtr() return value.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d72177fd4db4389689051dffc7c74a84e58dc4a4?ds=inline

Better document wxAutomationObject::GetDispatchPtr() return value.

This function returns IDispatch pointer as a void one, mention that the user
code needs to upcast it itself.

Closes #12617.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65927 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/msw/ole/automtn.h b/interface/wx/msw/ole/automtn.h
index 4f50efb493..9e0359177b 100644
--- a/interface/wx/msw/ole/automtn.h
+++ b/interface/wx/msw/ole/automtn.h
@@ -93,8 +93,11 @@ public:
 
     /**
         Gets the IDispatch pointer.
+
+        Notice that the return value of this function is an untyped pointer but
+        it can be safely cast to @c IDispatch.
     */
-    IDispatch* GetDispatchPtr() const;
+    void* GetDispatchPtr() const;
 
     /**
         Retrieves the current object associated with a class id, and attaches the