SDK:Tool Plug-in Main Function

From Vectorworks Developer
Jump to: navigation, search

.SDK|SDK ..SDK:Types|SDK Types ..SDK:Using the SDK|Using the SDK ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Tool Main Function

The prototype for a Tool’s definition procedure is:

extern "C" long plugin_main(
long action,
long message1,
long message2,
long& userData,
CallBackPtr cbp)

The parameters to the definition procedure are:

action long Identifies the context of the function call, and determines the significance of the message parameters.
message1 long The meaning of this parameter depends on the action.
message2 long The meaning of this parameter depends on the action.
userData long& Four bytes of data that VectorWorks maintains for the plug-in between calls. This is necessary because a plug-in cannot directly maintain its state between calls. See SDK:Global Data for more information.
cbp CallBackPtr An implementation detail. See Communication Between VectorWorks and Plug-ins for more information.

See Also

Overview | SDK:Tool Plug-in Resources | SDK:Tool Plug-in Main Function | SDK:Tool Plug-in Events

Personal tools

Advanced Search
See Also