Object Browser

There are two parts to the Object Browser. One part displays objects that have been instantiated in a running program, the other allows you to store useful references to objects. One is useful for debugging the other for development. The first is able to display COM, or SOAP object types. The second section allows COM Type Libraries and SOAP Object definitions to be displayed.

COM browser for ADO objects

For each object instance the tree control displays its methods, properties, events and enumerations. Some objects may have subsidiary objects such as collections. Expanding methods will show any arguments required together with their types. If the type is an enumeration then it too can be expanded to see the enumerated values. Optional arguments are surrounded by [] characters.

COM browser for References

The objects in the references section are displayed in exactly the same way. To place an object definition in the references section you will need to use the Object Management Dialog that can be opened using the down arrow icon in the Browser Window Toolbar.

Selecting a method or property of a COM object which has HelpString comments attached will display the comment at the bottom of the browser. The right click context menu can be used to display any available help file information. For Soap Objects there may be help documentation included in he WSDL definition. This documentation will also be displayed at the bottom of the browser.

The types of parameters and the return values of functions are shown for informational purposes in lower case inside parentheses after the variable name. These generally follow the COM conventions e.g. int(4) for a four byte signed integer. A variant type can be a string or a number depending on the requirements of the function.

For some parameters passed by reference the BYREF keyword will prefix the name indicating that it is required when passing the parameter from KCML. Additionally for numbers if the data type required is a double then the browser will display BYREF NUM(param name) to indicate that doubles have to be distinguished this way to KCML as numeric arguments passed by reference are otherwise assumed to be signed four byte integers.

Methods can be presumed to return an integer result unless the names is modified with a $ suffix implying a string result or a type, such as void for no result, is shown.

In the references section there are several different functions provided by either drag&drop or context menus. They depend upon which node you have selected. Below is a table that outlines these functions.

Node Type Context Menu Options Drag & Drop functionality
SOAP Object
  1. Help.
Will create an object definition in the code.
SOAP Method
  1. Help.
  2. Copy Method name to windows clipboard.
None.
COM Type Library or COM Object
  1. Help.
Will create an object definition in the code.
COM Method
  1. Help.
  2. Copy Method name to windows clipboard.
  3. Copy a $Declare statement to windows clipboard. The $Declare statement is automatic built from this objects methods. This is intended for use with the Windows API type library.
None.
Object Enumeration
  1. Help.
  2. Copy enumeration name to windows clipboard.
Insert the enumeration name in your program code.