4.12 The OLE-AUTOMATION module

in-process-automation-server

Macro

Summary

In-process Automation servers must call this macro at top-level in order to set up some static initializations needed for DLL initialization and registration.

Macro call

in-process-automation-server #key typeinfo title 
                                  class-ID prog-ID class 
                                  args versioned-prog-ID 
                                  versioned-title

Arguments

typeinfo

An instance of <disp-type-info> or <coclass-type-info>. Required.

title

An instance of <string>. Default value: see Description.

class-ID

An instance of <REFGUID> or <string>. Default value: see Description.

prog-ID

An instance of <string>. Default value: see Description.

class

The Dylan implementation class to be instantiated. Default value: see Description.

args

An instance of <sequence>. Default value: see Description.

versioned-prog-ID

An instance of <string>. Default value: see Description.

versioned-title

An instance of <string>. Default value: see Description.

Description

Note: Not applicable to local servers.

In-process Automation servers must call this macro at top-level in order to set up some static initializations needed for DLL initialization and registration. (It is not an executable expression.)

The macro expansion provides definitions for the Windows functions DllRegisterServer, DllUnregisterServer, DllGetClassObject, and DllCanUnloadNow. Without this, the container application will be unable to connect to the server.

This macro cannot be used more than once in a DLL library. The arguments are:

typeinfo:

The ITypeInfo interface that describes the services being provided. This should be an instance of <disp-type-info> or <coclass-type-info>. Required.

title:

String to appear in a container application's Insert Object dialog box, to identify this server application.

The value passed to the typeinfo: parameter contains a documentation string, probably provided by a keyword when creating the typeinfo. The value of title: defaults to that string.

prog-id:

The "programmatic identifier" string, as described for register-automation-server. Required.

class-id:

The COM class ID of the server object. Optional; defaults from the typeinfo.

class:

The class that should be instantiated when the server is invoked. Optional; defaults from the typeinfo if it is a coclass; otherwise, the class defaults to <simple-dispatch>.

args:

Optional <sequence> of arguments to be passed to make when instantiating the class. Defaults from the typeinfo if it is a coclass, otherwise, defaults to an empty sequence.

versioned-prog-id:

Optional string that is recommended to be the same as the Prog ID with a version identification appended.

versioned-title:

Optional title string that includes the program's version number.