Macro() Method

Summary

A COM method for calling a GISDK macro in a compiled GISDK UI Database.

Syntax

retval = Maptitude_Object.Macro(string macroname, string dbname, [optional Variant arg 1], [optional Variant arg2], ... [optional Variant arg9])

Argument Contents
macroname The name of the GISDK macro to be run
dbname The path and file name of the UI Database containing the GISDK macro
arg1, arg2, ... arg9 The macro arguments; their count and Variant types should match those specified for that macro

Returns

A Variant containing either the return value specified for the GISDK macro, or Null.

Notes

  • If the argument specified is a string, integer, or real, then the Variant type must match.

  • If the argument is an array, then the Variant type must be a SafeArray of Variants of appropriate types.

  • A null value can be passed as a Variant of type Null.

  • Arguments of the compound types in Caliper Script are passed as MacroVal objects in the Variants (see MacroVal Object).

  • An old name for this method is RunUIMacro().

For more information, see...

The Maptitude Object

Function() Method

CreateObject() Method

The MacroVal Object

Accessing Maptitude as a COM Object