Robert Shearman : ole32: Document CoCreateFreeThreadedMarshaler.

[Alexandre Julliard]

Module: wine
Branch: refs/heads/master
Commit: 1ddc722ec243200ec5b16792cbfde5b68d151c84
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=1ddc722ec243200ec5b16792...

Author: Robert Shearman <rob(a)codeweavers.com>
Date:   Sat Jun 17 12:31:54 2006 +0100

ole32: Document CoCreateFreeThreadedMarshaler.

---

 dlls/ole32/ftmarshal.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/dlls/ole32/ftmarshal.c b/dlls/ole32/ftmarshal.c
index 7493bab..6f80091 100644
--- a/dlls/ole32/ftmarshal.c
+++ b/dlls/ole32/ftmarshal.c
@@ -302,6 +302,23 @@ static const IMarshalVtbl ftmvtbl =
 /***********************************************************************
  *          CoCreateFreeThreadedMarshaler [OLE32.@]
  *
+ * Creates a free-threaded marshaler.
+ *
+ * PARAMS
+ *  punkOuter    [I] Optional. Outer unknown.
+ *  ppunkMarshal [O] On return, the inner unknown of the created free-threaded marshaler.
+ *
+ * RETURNS
+ *  Success: S_OK
+ *  Failure: E_OUTOFMEMORY if no memory available to create object.
+ *
+ * NOTES
+ *  Objects that ensure their state is maintained consistent when used by
+ *  multiple threads and reference no single-threaded objects are known as
+ *  free-threaded. The free-threaded marshaler enables these objects to be
+ *  efficiently marshaled within the same process, by not creating proxies
+ *  (as they aren't needed for the object to be safely used), whilst still
+ *  allowing the object to be used in inter-process and inter-machine contexts.
  */
 HRESULT WINAPI CoCreateFreeThreadedMarshaler (LPUNKNOWN punkOuter, LPUNKNOWN * ppunkMarshal)
 {