4.12 The OLE-AUTOMATION module

register-automation-server

Function

Summary

register-automation-server class-ID prog-ID title-string 
                           #key versioned-prog-ID 
                                versioned-title => ()

Arguments

class-ID

An instance of <string> or <REFGUID>.

prog-ID

An instance of <string>.

title-string

An instance of <string>.

versioned-prog-ID

An instance of false-or(<string>).

versioned-title

An instance of false-or(<string>).

Values

None.

Description

If the application was invoked with the command-line argument /RegServer or -RegServer, this function creates the Windows Registry entries necessary for the current application to be invoked by an Automation controller. If the application was invoked with /UnregServer or -UnregServer, this function attempts to delete any registry entries belonging to the application.

This function returns no values.

The class-ID argument must be the same value as passed as the clsid: argument to make on <class-factory>, or as the uuid: argument to make on <coclass-type-info>.

Note that if you want to be able to have two versions of a program installed at the same time, then both versions must have different Class IDs, and you must also specify a versioned-prog-id: for each.

The prog-id argument must be the class's programmatic identifier or Prog ID. A Prog ID is a unique symbolic alias for a numeric GUID, represented by a string. (Prog IDs allow a server to be used by Visual Basic and are also required for compatibility with OLE1.) A Prog ID must begin with a letter; it cannot contain any spaces or punctuation except the period (.) character, and it must not be more than 39 characters long. In order to ensure uniqueness, the recommended format is:

  <vendor-name>.<product-name>

For example:

  AcmeWidgets.FrobMaster

The title-string identifies the program in displays to its user. It should not include the version number.

The optional versioned-prog-id must be either #f or a string. We recommend that it be the same as the prog-ID, with a version identification appended. For example:

  AcmeWidgets.FrobMaster.2.1

The optional versioned-title must be either #f, or a title string that includes the program's version number.