Changeset 32843 in vbox for trunk/include/VBox/com/ptr.h

Timestamp:

Sep 30, 2010 1:20:23 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

66310

Message:

Main: Added an example on how to convert a ComObjPtr to an ComPtr of the same
type. I never remember that.

File:

• trunk/include/VBox/com/ptr.h (modified) (1 diff)

trunk/include/VBox/com/ptr.h

@@ -406 +406 @@
  * The methods behave the same except that ComObjPtr has the additional createObject()
  * method which allows for instantiating a new implementation object.
+ *
+ * Note: To convert a ComObjPtr<InterfaceImpl> to a ComObj<IInterface> you have
+ * to query the interface. See the following example code for the IProgress
+ * interface:
+ *
+ *  @code
+ *
+ *  {
+ *      ComObjPtr<Progress> pProgress;          // create the server side object
+ *      pProgress.createObject();               // ...
+ *      pProgress->init(...);                   // ...
+ *      ComPtr<IProgress> pProgress2;           // create an interface pointer
+ *      pProgress.queryInterfaceTo(pProgress2); // transfer the interface
+ *  }
+ *
+ *  @endcode
  */
 template <class T>