7.3 The OLE-CONTROL-FRAMEWORK module

initialize-ole-control

Macro

Summary

Required macro call for OLE control initialization and registration.

Macro call

initialize-ole-control (coclass-type-info prog-ID 
                        #rest options)

Arguments

coclass-type-info: An instance of <coclass-type-info>.
prog-ID: An instance of <string>.
options: Optional keyword and value pairs for additional registration options. See Description.

Library

OLE-Control-Framework

Module

OLE-Control-Framework

Description

OLE control applications must call this macro at top level in order to set up some static initializations necessary for the control DLL/OCX's initialization and registration. (It is not an executable expression.)

The macro-expansion provides definitions for the OLE/COM functions DllRegisterServer, DllUnregisterServer, DllGetClassObject, and DllCanUnloadNow.

If your control does not make this macro call, control container applications will not be able to connect to it.

You cannot use this macro more than once in a DLL library.

The coclass-type-info argument is the type information describing the control's Automation functionality. It must be an instance of <coclass-type-info>, where the class: init-keyword passed to make specified your control's subclass of <OLE-control-framework>.

The prog-ID argument is the programmatic identifier string, as described for register-ole-server, page 284.

The options arguments are optional keyword and value pairs for additional registration options. The values accepted are any that are specified for register-ole-server or register-automation-server, page 231, except that title: is accepted in place of the title-string positional argument (it defaults from the name: of the type info) and the default value for the verbs: option is:

vector(vector($OLEIVERB-PRIMARY, "&Edit", $MF-ENABLED,
              $OLEVERBATTRIB-ONCONTAINERMENU))