Share via

CoCreateFreeThreadedMarshaler (Compact 2013)

  • Article

3/26/2014

This function creates an aggregatable object capable of context-dependent marshaling.

Syntax

HRESULT CoCreateFreeThreadedMarshaler(
  LPUNKNOWN punkOuter,
  LPUNKNOWN* ppunkMarshaler
);

Parameters

  • punkOuter
    [in] Pointer to the aggregating object's controlling IUnknown.
  • ppunkMarshaler
    [out] Address of IUnknown* pointer variable that receives the interface pointer to the aggregatable marshaler.

Return Value

This function supports the standard return value E_OUTOFMEMORY, as well as the following:

  • S_OK
    The marshaler was created.

Remarks

The CoCreateFreeThreadedMarshaler function enables an object to efficiently marshal interface pointers between threads in the same process.

If your objects do not support interthread marshaling, you have no need to call this function. It is intended for use by free-threaded DLL servers that must be accessed directly by all threads in a process, even those threads associated with single-threaded apartments.

It custom-marshals the real memory pointer over into other apartments as a bogus proxy and gives direct access to all callers, even if they are not free-threaded.

The CoCreateFreeThreadedMarshaler function performs the following tasks:

  1. Creates a free-threaded marshaler object.
  2. Aggregates this marshaler to the object specified by the punkOuter parameter. This object is normally the one whose interface pointers are to be marshaled.

The aggregating object's implementation of IMarshal should delegate QueryInterface calls for IID_IMarshal to the IUnknown of the free-threaded marshaler. Upon receiving a call, the free-threaded marshaler performs the following tasks:

  1. Checks the destination context specified by the CoMarshalInterface function's dwDestContext parameter.
  2. If the destination context is MSHCTX_INPROC, copies the interface pointer into the marshaling stream.
  3. If the destination context is any other value, finds or creates an instance of COM's default (standard) marshaler and delegates marshaling to it.

Values for dwDestContext come from the MSHCTX enumeration. MSHCTX_INPROC indicates that the interface pointer is to be marshaled between different threads in the same process.

Because both threads have access to the same address space, the client thread can dereference the pointer directly rather than having to direct calls to a proxy.

In all other cases, a proxy is required, so CoCreateFreeThreadedMarshaler delegates the marshaling job to COM's default implementation.

Great care should be exercised in using the CoCreateFreeThreadedMarshaler function.

This is because the performance of objects which aggregate the free-threaded marshaler is obtained through a calculated violation of the rules of COM, with the ever-present risk of undefined behavior unless the object operates within certain restrictions.

The most important restrictions are as follows:

  1. A free-threaded marshaler object cannot hold direct pointers to interfaces on an object that does not aggregate the free-threaded marshaler as part of its state.
    If the object were to use direct references to ordinary single-threaded aggregate objects, it may break their single threaded property.
    If the object were to use direct references to ordinary multi-threaded aggregate objects, these objects can behave in ways that show no sensitivity to the needs of direct single-threaded aggregate clients.
    For example, these objects can spin new threads and pass parameters to the threads that are references to ordinary single-threaded aggregate objects.
  2. A free-threaded marshaler object cannot hold references to proxies to objects in other apartments. Proxies are sensitive to the threading model and can return RPC_E_WRONG_THREAD if called by the wrong client.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

Header

objbase.h

Library

ole32.lib

See Also

Reference

COM Functions
CoMarshalInterThreadInterfaceInStream
CoGetInterfaceAndReleaseStream