Show Hide

 

Feedback

  • Contents
 

Naming Conventions in the Designer COM API Reference

The Designer COM API Reference describes COM components in a structured way. Hyperlinks make it easy to navigate and drill down, without becoming "lost in hyperspace."

Interface list

At the topmost level, interfaces are described in an interface list. You can drill down to specific interface pages by clicking on interface name hyperlinks. The description of each interface is followed by a list of properties that the interface supports (if any), and by an alphabetical list of methods. To make it easier to identify the interface associated with each method, interface and method names are appended together in topic titles, using two colons as a delimiter.

Syntax

InterfaceName::MethodName

Example

IEICCallObject::Dial

Property and Method pages

Each interface page contains a list of properties supported by the interface. This list is followed by a list of methods that the interface supports. You can drill down to a specific property page or method page by clicking on hyperlinks.

Each property or method page is divided into sections:

  • A Synopsis statement describes each property or method.

  • Function Prototypes describe methods and properties in a generic way, independent of specific language syntax. Those of you who are familiar with IDL (Interface Definition Language) will immediately recognize the format used here. Function prototypes specify the data type of each argument, and indicate whether arguments are optional, supplied as an input variable, or return value.

  • GET vs. PUT: property pages are divided into two sections that discuss GETs and PUTs separately. Separate function prototypes, calling syntax, and examples are provided for get (read) and put (write) operations. Methods have only a single function prototype.

  • Calling Syntax: example syntax is provided for C++. In some cases, the C++ example is followed by a list of C++ Return values that describe constants associated with a particular method or property.

  • Parameter List: parameters are described individually.