CLUE Server object

Description

The "ClueServer" object is the only CLUE object that can be directly created by the client application.

All other objects are created by using methods of the Server or other objects created from the server.

A CLUE client application must create at least one instance of the Server object. Generally the handle to this object should be global in scope.

In Visual Basicä the a reference is created to the relevant server program and the server is then created using the following line:

  • Global serv as New ClueServer
    ' uses Clue.exe or Clue16.exe to provide Browser and Reference services
    •

    ... or the following lines can be used to invoke the separate browser and reference servers

  • Global servA as New ClueDllServer
    ' uses Cluelib.dll Reference services only - not available for 16-bit systems
  • Global servB as New ClueBrwServer
    ' uses Cluex.exe or Clue16x.exe to provide enhanced Browser services only
    •

    Properties

    About

    Data Type: STRING – Read-only

    A string containing the properties of the current instance of the server object.

    Available

    Data Type: BOOLEAN – Read-only

    Indicates whether the server is available. This may depend on licence conditions and expiry date. To avoid errors this property should be checked when invoking a new instance of the server.

    ClientApp

    Data Type: OBJECT

    Set this as a pointer to the client application to check validity of licence and allow call-back. This must be set when initiating an instance of the server. If it is not set the Available property returns false and the server will not operate unless the server has a demonstration licence expiry date after the current system date.

    ExpiryDate

    Data Type: VARIANT (date) – Read-only

    Indicates when the main licence on the server expires. The server may work after expiry with a limited range of licensed applications. See also the property "Available".

    Name

    Data Type: STRING – Read-only

    The name of the server object (i.e. "ClueServer", "ClueDllServer" or "ClueBrwServer").

    The Name property is not a standard part of the RV3 API but has been added to all CLUE API objects. This allows simpler debugging of client code. It can also be used to check the object type when a general object handle is used.

    ObjErr

    Data Type: INTEGER

    An integer containing the error or status code generated by the last method applied to this object.

    Methods

    NewConfiguration

    Returns a handle to a new instance of the Configuration object.

    The initial Configuration property settings are set to their default values.

    NewReference

  • Server.NewReference
    •

    Returns a handle to a new instance of the Reference object.

    Note: This method is not supported by ClueBrwServer.

    NewBrowser

  • Server.NewBrowser
    •

    Returns a handle to a new instance of the Browser object.

    Note: This method is not supported by ClueDllServer.

    ErrorText

  • Server.ErrorText([Erx])
    •

    Returns a string containing the plain text description of an error. The error reported depends on the value of the parameter Erx: