Home > Articles > Programming > General Programming/Other Languages

Automation in Delphi COM Programming

In this selection excerpted from Delphi COM Programming, author Eric Harmon discusses interfaces and automation, variants and automation, dispinterfaces, dual interfaces, and automating Microsoft ADO.

In the past three chapters, I've spent a lot of time discussing interfaces and how to create COM objects. I also introduced you to type libraries in Chapter 3, "Type Libraries." This chapter is where everything comes together. If you've been feeling a little disheartened about COM up until now, this is where that will change. This chapter is long, but it has many sample programs in it. I personally feel that this is probably the most important chapter in the book. I want to make sure you have a handle on what's being discussed here. In this chapter, I'll discuss

  • Interfaces and automation

  • Variants and automation

  • Dispinterfaces

  • Dual interfaces

  • Automating Microsoft ADO

In Chapter 3, I showed you what a type library is, how to create one, and how you can read the information out of a type library. As you saw, extracting the type information manually is tedious at best. The good news is that you typically won't need to work directly with type library data. In most cases, you will work with a type library indirectly through automation.

Defining Automation

As its name suggests, automation is a way to automatically control an application from within another application. Actually, you can build both in-process and out-of-process automation servers. As you'll see later in this chapter, each type of automation controller has its benefits.

Delphi makes it so easy to create and use automation servers that you almost do not need to know much, if anything, about COM basics. It's very easy to create a simple automation client.

procedure TForm1.Button1Click(Sender: TObject);
var
 V: Variant;
begin
 V := CreateOleObject('Word.Basic');
 V.AppShow;
 V.FileNew;
 V.Insert('Automation is easy!');
end;

Believe it or not, this little snippet of code will start Word, create a new document, and insert the text "Automation is easy!" into the document.

Later in this chapter, in the section titled "Variants," I'll explain exactly what's going on in this code, but my goal at this point is to show you just how simple automation can be in Delphi.

Interfaces

By now I assume that you understand what interfaces are and how to use them. Interfaces are one of the two main methods used to gain access to an automation server's COM objects.

When you control an automation server through an interface, you use early binding. Early binding simply means that all calls made to interface methods are checked for the correct parameters at compile time. As a Delphi programmer, you should be familiar with early binding.

You've seen numerous examples of interfaces in previous chapters, so I won't show a procedure here for controlling an automation server through interfaces. This chapter provides many examples that use interfaces to control an automation server.

Variants

I discussed variants briefly in Chapter 2, "Interfaces and COM," mainly with respect to variant arrays. Not obviously, variants can also be used to control an automation server.

When you control an automation server through variants, you are using late binding. Late binding means that method calls are not resolved until runtime. This has some interesting ramifications. Consider the following code, which connects to Microsoft Word and instructs it to create a new file:

procedure TForm1.Button1Click(Sender: TObject);
var
 V: Variant;
begin
 V := CreateOleObject('Word.Basic');
 V.AppShow;
 V.FileNew;
 V.Insert('Automation is easy!');
end;

I'm not going to go into detail about the CreateOleObject at this moment. Suffice it to say that it is used to create an instance of an automation server. I'll come back and discuss that function in more detail later.

What CreateOleObject actually does in this example is start a copy of Microsoft Word. It then obtains a reference to the Word.Basic interface, and stores that reference in the variant V.

By default, automation servers typically start up as hidden. The AppShow method displays the Word application.

Then, a call is made to V.FileNew, which creates a new Word document. Delphi (and Windows) performs a tremendous amount of work behind the scenes to transform V.FileNew into a function call that creates a new document.

It's interesting to note that a variant is not a pointer to an object. How can you call methods on that "object," then? The answer is late binding. Delphi will actually accept anything you type here, without performing any type checking at all at compile time—in other words, Delphi does not perform early binding on variants. For instance, I could just as easily write the following code:

V.DelphiRules;

Delphi will compile this code just fine, but you can be fairly certain that Word doesn't implement a method called DelphiRules. If you attempt to execute this statement, you will receive the runtime error shown in Figure 4.1.

Figure 4.1
Calling a non-existent automation method results in this screen.

To understand how Delphi turns this code into method calls, we need to take a look at the IDispatch interface.

IDispatch is defined in the file system.pas like this:

 IDispatch = interface(IUnknown)
 ['{00020400-0000-0000-C000-000000000046}']
 function GetTypeInfoCount(out Count: Integer): HResult; stdcall;
 function GetTypeInfo(Index, LocaleID: Integer; out TypeInfo): HResult; stdcall;
 function GetIDsOfNames(const IID: TGUID; Names: Pointer;
  NameCount, LocaleID: Integer; DispIDs: Pointer): HResult; stdcall;
 function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer;
  Flags: Word; var Params; VarResult, ExcepInfo, ArgErr: Pointer): HResult; stdcall;
 end;

The methods GetTypeInfoCount and GetTypeInfo should trigger something in your brain. IDispatch must consult the type library associated with the automation controller in order to resolve function calls at runtime.

That's exactly correct. As a matter of fact, what happens is the following:

  1. Delphi passes the name of the method to IDispatch.GetIDsOfNames.

  2. GetIDsOfNames returns an integer ID representing the method name.

  3. Delphi calls the Invoke method, using the ID returned in Step 2.

This sequence of steps occurs for every method that you call on an object through a variant. The time required to execute these three steps is considerably longer than accessing the same object directly through an interface.

As a Delphi programmer, you might wonder why on earth anyone would want to use IDispatch to access an automation server. There are two very good reasons for doing so:

  1. You're writing a program or macro in an application that doesn't support interfaces. Examples are Visual Basic or Microsoft Word.

  2. You're writing a quick and dirty client program in Delphi, and you don't want to go through the bother of importing a type library.

Dispinterfaces

Somewhere between interfaces and variants are dispinterfaces. A dispinterface declaration looks almost identical to an interface declaration, except it uses the keyword dispinterface instead of interface. Here is a simple interface declaration, and then the corresponding dispinterface declaration.

// *********************************************************************//
// Interface: IUnitAuto
// Flags:  (4416) Dual OleAutomation Dispatchable
// GUID:  {A1E420C1-F75F-11D2-B3B9-0040F67455FE}
// *********************************************************************//
 IUnitAuto = interface(IDispatch)
 ['{A1E420C1-F75F-11D2-B3B9-0040F67455FE}']
 function Convert(Quantity: Double; InUnit: Integer; OutUnit: Integer): Double; 
safecall;
 end;

// *********************************************************************//
// DispIntf: IUnitAutoDisp
// Flags:  (4416) Dual OleAutomation Dispatchable
// GUID:  {A1E420C1-F75F-11D2-B3B9-0040F67455FE}
// *********************************************************************//
 IUnitAutoDisp = dispinterface
 ['{A1E420C1-F75F-11D2-B3B9-0040F67455FE}']
 function Convert(Quantity: Double; InUnit: Integer; OutUnit: Integer): Double; 
dispid 1;
 end;

This Delphi-generated code is taken directly from the first example program later in this chapter, so I'm not going to explain it in detail right now.

You should notice several things about this code right away.

  • The IUnitAuto interface is derived from IDispatch, so if you create an automation server that implements IUnitAuto, clients can use late binding to talk to it.

  • The IUnitAuto method Convert is declared as safecall.

  • The IUnitAuto interface and IUnitAutoDisp dispinterface both use the same GUID.

  • The IUnitAutoDisp dispinterface defines the same method (Convert) that the IUnitAuto interface defines. However, the dispinterface includes dispid 1 at the end of the method name.

When you use a dispinterface, you eliminate the first two steps associated with IDispatch. The automation controller does not have to call GetIDsOfNames, and the server does not have to respond with the dispid of the method in question. Instead, the dispid is determined at compile time. At runtime, the client program simply calls Invoke with the predetermined dispid.

Dispinterfaces are for client convenience only. You do not actually implement a dispinterface on the server. The server implements interfaces. The client application can elect to connect to the server using variants or dispinterfaces, assuming that the server's COM object also supports the IDispatch interface.

Dual Interfaces

A dual interface is simply defined as an automation server that supports clients connecting to it using interfaces (early bound) as well as clients connecting to it using variants (late bound). Any automation servers that you create with Delphi will automatically support a dual interface. This is desirable because it means that any automation server that you write can be accessed by almost any piece of software on the market today.

This section thoroughly covered automation and the way clients can access automation servers through use of interfaces, variants, dispinterfaces, and dual interfaces. The next section will take that information and apply it to the creation and use of in-process automation servers.

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.

Overview


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.

Surveys

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.

Newsletters

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.

Security


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

Children


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

Marketing


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.

Choice/Opt-out


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.

Links


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