Edit

Share via

CoMarshalInterThreadInterfaceInStream function (combaseapi.h)

  • Article

Marshals an interface pointer from one thread to another thread in the same process.

Syntax

HRESULT CoMarshalInterThreadInterfaceInStream(
  [in]  REFIID    riid,
  [in]  LPUNKNOWN pUnk,
  [out] LPSTREAM  *ppStm
);

Parameters

[in] riid

A reference to the identifier of the interface to be marshaled.

[in] pUnk

A pointer to the interface to be marshaled, which must be derived from IUnknown. This parameter can be NULL.

[out] ppStm

The address of the IStream* pointer variable that receives the interface pointer to the stream that contains the marshaled interface.

Return value

This function can return the standard return values E_OUTOFMEMORY and S_OK.

Remarks

The CoMarshalInterThreadInterfaceInStream function enables an object to easily and reliably marshal an interface pointer to another thread in the same process. The stream returned in the ppStm parameter is guaranteed to behave correctly when a client running in the receiving thread attempts to unmarshal the pointer. The client can then call the CoGetInterfaceAndReleaseStream to unmarshal the interface pointer and release the stream object.

The CoMarshalInterThreadInterfaceInStream function performs the following tasks:

  1. Creates a stream object.
  2. Passes the stream object's IStream pointer to CoMarshalInterface.
  3. Returns the IStream pointer to the caller.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header combaseapi.h (include Objbase.h)
Library Ole32.lib
DLL Ole32.dll

See also

CoGetInterfaceAndReleaseStream