Home > Articles > Programming

Using COM to Develop UMDF Drivers, Part 2

📄 Contents

  1. Using COM to Develop UMDF Drivers (Part 2 of 2)
  2. Implementing <tt>QueryInterface</tt>
Ronald D. Reeves, Ph.D., the author of Windows 7 Device Driver, concludes his series on creating User Mode Driver Framework (UMDF) drivers with a look at the additional required basic COM infrastructure used to support your UMDF drivers.
Like this article? We recommend

Like this article? We recommend

Part 1 of this series examined the overall architecture of using COM to create user mode drivers. This article concludes this discussion by looking at the additional details involved in completing your user mode driver using COM.

Reference Counting

Unlike C++ objects, a COM client doesn't directly manage the lifetime of a COM object. Instead, a COM object maintains a reference count on itself. When a client creates a new object with an object-creation method, the object has a reference count of 1. Each time the client requests an additional interface on the object, it increments the reference count. When the client is finished with the interface, it releases the interface pointer, which decrements the reference count. When all the interface pointers on the object have been released, the reference count is 0 and the object destroys itself.

Basic Infrastructure Implementation

In this section, we'll look at the required basic infrastructure to support UMDF drivers.

Performing Tasks with the DllMain Function

A dynamic link library (DLL) can contain any number of in-process COM objects, but it must have a single entry point named DllMain. Windows calls DllMain after the binary has been loaded into a host process and before it's unloaded. The function is also called when threads are created or destroyed. The dwReason parameter indicates why the function was called.

When a UMDF driver's DllMain function is called for DLL loading or unloading, it should perform only simple module-wide initialization and termination tasks, such as initializing/freeing global variables, or registering/unregistering Windows software trace preprocessor (WPP) tracing. There a number of things DllMain definitely should not do, such as calling LoadLibrary. When a UMDF driver's DllMain function is called for thread creation or destruction, it can ignore the call.

Accessing Class Factories with DllGetClassObject

Because class factories aren't exported by name, there's no direct way for a client to get access to them. Instead, the DLL exports the DllGetClassObject function by name, which allows it to be called by any client with access to the DLL. For many COM DLLs, including the UMDF samples, DllGetClassObject is the only function listed in the project's .def file to be exported by name from the DLL.

When a client wants to create an instance of one of the COM objects in the DLL, it passes the CLSID of the desired class factory object to DllGetClassObject and the IID of the desired interface, usually IClassFactory. DllGetClassObject creates a new class factory object and returns a pointer to the appropriate interface on the object. The client can then use the IClassFactory::CreateInstance method to create an instance of the object.

Working with the Driver Object's Class Factory

Some COM objects must be created by external clients. For UMDF drivers, there is usually only one such object: the driver callback object. A COM object that can be created by an external client must have a class factory. This is a small specialized COM object and returns a pointer to a specified interface.

Class factories usually expose only one interface in addition to IUnknown: the IClassFactory interface, which has two members:

  • CreateInstance creates an instance of the object and returns the requested interface pointer to the client.
  • LockServer can be used to keep the DLL in memory. UMDF class factories typically have only a token implementation because UMDF doesn't use LockServer.

Some recommendations for implementing CreateInstance:

  • Ignore the first parameter. Its purpose is to support COM aggregation, which isn't used by UMDF.
  • Create a new driver callback object by whatever means is convenient. The sample code puts the object-creation code in a static method on the class that implements the callback object.
  • Return the appropriate interface as an OUT parameter. At this point, the object should have a reference count of 1.

Implementing a UMDF Callback Object

A UMDF driver consists of a collection of COM callback objects. These objects respond to notification by the UMDF runtime and allow the driver to process various events, such as read or write requests. All callback objects are in-process COM objects. This means that they're packaged in a DLL and run in the process context of a UMDF host.

The basic requirements for implementing UMDF callback objects are relatively simple and straightforward:

  • Implement the IUnknown methods to handle reference counting and provide pointers to the object's interface.
  • Implement the methods of the UMDF callback interfaces that will be exported by the object.

Implementing the UMDF Callback Class

UMDF callback objects are typically implemented as a C++ class that contains the code to support IUnknown plus any UMDF interfaces that the object exposes. The UMDF interfaces are declared in wudfdd.h. Following are some of the requirements:

  • The class must inherit from every interface that it exposes. However, it can do so indirectly; for example, by inheriting from a class that in turn inherits from one or more interfaces.
  • Interfaces are declared as abstract base classes, so the class must implement all the interface methods.
  • The class often inherits from a parent class in addition to interfaces. Many of the UMDF samples, for instance, inherit from a parent class named CUnknown, which contains a base implementation of IUnknown.
  • The class can contain private data members, public methods that are not part of an interface, and so on. These are for internal use and are not visible to clients.
  • Constructors are optional. However, if a class has a constructor, it should contain no code in it that fails. Put any code that can fail in a public initialization method that can be called after object creation.

As mentioned earlier, a UMDF callback object is typically implemented as a class that inherits from IUnknown and one or more object-specific interfaces. Listing 1 shows the full declaration of the CMyDriver class. This class inherits from a single UMDF interface IDriverEntry and inherits from IUnknown through the CUnknown parent class. For convenience, several of the simpler methods are implemented here, rather than in the associated .cpp file.

Listing 1  Declaration of a driver's callback object.

Class CMyDriver : public Unknown, Public IDriverEntry
    IDriveEntry * QueryIdriveEntry (VOID)
        return static_cast<IDriverEntry*>(this);
    HRESULT initialize(VOID)
    static HRESULT CreateInstance)__out PCMYDriver *Driver);
    virtual HRESULT STDMETHODCALLTYPE OnInitialize(__in
                    IWDFDriver *FxWdfDriver)
        return S_OK;
                  __in IWDFDriver *FwWdfDriver,
                 __in IWDFDeviceInitialize *FxDeviceInit);
    virtual VOID STDMETHODCALLTYPE OnDeInitialize(
                 __in IWDFDriver *FxWdfDriver)
        return __super::AddRef();
        return __super::Release();
    virtual HRESULT STDMETHODCALLTYPE QueryInterface(
        __in REFID InterfaceID,
        __deref_out PVOID *Object);

IUnknown is the core COM interface; it's exposed in every COM object and is essential to the object's operation. The approach used by the UMDF sample code is to have an IUnknown base class, called CUnknown, plus an implementation for each exposed interface that inherits from the base class.

Implementing AddRef and Release

Reference counting is arguably the key task of IUnknown. Normally, a single reference count is maintained for the object as a whole. Following are some recommendations for handling AddRef and Release:

  • Interface-specific implementations should pass their calls to the base implementation and let it handle incrementing or decrementing the reference count for the object.
  • Use InterlockedIncrement and interlockedDecrement to modify the reference count. This eliminates the possibility of a race condition.
  • After the Release method decrements the reference count, check to see whether the count has gone to 0. If so, there are no outstanding interface pointers and you can delete to destroy the object.
  • Both AddRef and Release return the current reference count. Use this technique for debugging purposes.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020