GenericEngine_Alteryx
Important
This C++ SDK uses outdated technology that limits your extension opportunities. We've built a new Platform SDK using Python and the latest open-source technology to deliver a vastly improved development experience. Go to Platform SDK to get started!
The GenericEngine_Alteryx class provides an abstraction of the Alteryxengine that allows you to associate RecordInfo and FieldBase objects by exposing some of the EngineInterface functionality.
Constructor
To instantiate a new instance of the GenericEngine_Alteryx class:
GenericEngine_Alteryx(EngineInterface * pEngineInterface, int nToolId, int nFieldConversionErrorLimit)
pEngineInterface: A pointer to the EngineInterface.
nToolId: The ID of the tool.
nFieldConversionErrorLimit: The number of field conversion errors allowed before processing is terminated. This parameter should be obtained from the GetInitVar method of the EngineInterface class.
Methods
OutputMessage
Notify the Alteryxengine of messages produced by the tool. Returns a 1 to stop processing, and a 0 to continue processing.
long OutputMessage(MessageType mt, const wchar_t *pMessage)
mt: The type of message being sent. Valid values are:
MT_Info
MT_Warning
MT_Error
MT_FieldConversionError
MT_FieldConversionLimitReached
pMessage: the text of the message being sent.
QueueThread
Queue a procedure for execution on a new thread.
void QueueThread(ThreadProc pProc, void *pData)
pProc: The procedure to be queued. The function pointed to must have the signature void Proc(void *pData).
pData: A pointer to the data to be processed by the specified procedure.