Initiate Method

4. Designing and Writing OpenROAD Server Applications : How You Can Drive the OpenROAD Server from a Client : COM (Non-OpenROAD) Client Remote Server Object : Initiate Method

Share this page

Initiate Method

The Initiate method bypasses the Name Server and connects to an appropriate server process that hosts the specified OpenROAD application image. To make a connection using the Name Server, use the Connect method instead.

HRESULT Initiate
    (
        [in] BSTR ImageFile,
        [in, optional] BSTR CmdFlags,
        [in, optional] BSTR Location,
        [in, optional] BSTR Routing,
        [in, optional] LONG PrivateOrShared,
        [in, optional] VARIANT * Options
    );

An Initiate must be done once—and only once—prior to using the CallProc or Call4GL methods.

This method uses the following parameters:

ImageFile

Contains the image file name of the OpenROAD file to be initiated

CmdFlags

Contains command line flags to be passed to that application on startup

Location

Identifies the location where the OpenROAD Server is started. Contains the machine name (or Domain Name Server [DNS] name or Internet Protocol [IP] address) of the machine on which the OpenROAD Server is to be run. If no location is specified, the DCOM settings on the client machine are used to determine where to locate the server.

Routing

Specifies a routing string. Specifying “unauthenticated” enables an explicitly unauthenticated connection to the Name Server. This overrides the default authentication level currently set for the client process.

PrivateOrShared

Specifies whether to launch a private server or connect to a shared server. A zero value indicates a shared server; a non-zero value indicates a private server.

Default: shared server

The requested server “application signature” (that is, the combination of the ImageFile string and the CmdFlags string) determines which clients may share a server instance. A shared server is shared only by clients that have specified the same signature.

Options

Reserved for future use

Typically, the Connect method should be used to connect to the server process. This makes a connection through the Name Server, which is configured using the Server Manager. For more information, see Managing and Monitoring the OpenROAD Server (see Managing and Monitoring the OpenROAD Server).