Initializing the COM Library

Any Windows program that uses COM must initialize the COM library by calling the CoInitializeEx function. Each thread that uses a COM interface must make a separate call to this function. CoInitializeEx has the following signature:

HRESULT CoInitializeEx(LPVOID pvReserved, DWORD dwCoInit);

The first parameter is reserved and must be NULL. The second parameter specifies the threading model that your program will use. COM supports two different threading models, apartment threaded and multithreaded. If you specify apartment threading, you are making the following guarantees:

  • You will access each COM object from a single thread; you will not share COM interface pointers between multiple threads.
  • The thread will have a message loop. (See Window Messages in Module 1.)

If either of these constraints is not true, use the multithreaded model. To specify the threading model, set one of the following flags in the dwCoInit parameter.

FlagDescription
COINIT_APARTMENTTHREADEDApartment threaded.
COINIT_MULTITHREADEDMultithreaded.

 

You must set exactly one of these flags. Generally, a thread that creates a window should use the COINIT_APARTMENTTHREADED flag, and other threads should use COINIT_MULTITHREADED. However, some COM components require a particular threading model. The MSDN documentation should tell you when that is the case.

Note  Actually, even if you specify apartment threading, it is still possible to share interfaces between threads, by using a technique called marshaling. Marshaling is beyond the scope of this module. The important point is that with apartment threading, you must never simply copy an interface pointer to another thread. For more information about the COM threading models, see Processes, Threads, and Apartments and Understanding and Using COM Threading Models.

In addition to the flags already mentioned, it is a good idea to set the COINIT_DISABLE_OLE1DDE flag in the dwCoInit parameter. Setting this flag avoids some overhead associated with Object Linking and Embedding (OLE) 1.0, an obsolete technology.

Here is how you would initialize COM for apartment threading:

HRESULT hr = CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE);

The HRESULT return type contains an error or success code. We'll look at COM error handling in the next section.

Uninitializing the COM Library

For every successful call to CoInitializeEx, you must call CoUninitialize before the thread exits. This function takes no parameters and has no return value.

CoUninitialize();

Next

Error Codes in COM

 

 

Send comments about this topic to Microsoft

Build date: 10/5/2010

Community Additions

ADD
Show: