ImplementPluginInterface

Version:
Current
Last modified: June 15, 2020

ImplementPluginInterface

The ImplementPluginInterface class initializes a PluginInterface for a tool. This class assumes your tool adheres to the standardized naming conventions:

PI_AddIncomingConnection(const wchar_t* pIncomingConnectionType, const wchar_t* pIncomingConnectionName, IncomingConnectionInterface* r_IncConnInt) PI_AddOutgoingConnection(const wchar_t* pOutgoingConnectionName, IncomingConnectionInterface* pIncConnInt) PI_Close(bool bHasErrors) PI_PushAllRecords(__int64 nRecordLimit)

Because this is a templated class, you must specify the type when calling methods.

Methods

Init

Initialize a plugin interface.

static void Init(int nToolId, const EngineInterface * pEngineInterface, PluginInterface *r_pluginInterface, T_PI *pPluginInterface, bool bTakeOwnership)

nToolId: The ID of the tool calling the function.

pEngineInterface: A pointer to the Alteryxengine provided to the plugin's entry point.

r_pluginInterface: A pointer to the PluginInterface object to initialize.

pPluginInterface: An unmanaged pointer to the instance of your plugin.

bTakeOwnership: An option that determines if Alteryx is responsible for releasing the PluginInterface once processing is complete:

  • True: Alteryx is responsible.
  • False: Interface release is managed by the tool.
Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.