IOXConfigure

 Top  Previous  Next

 

extern "C" __declspec(dllexport) int IOXConfigure(

CONFIGUREPARMSIN *pParmsIn,

CONFIGUREPARMSOUT *pParmsOut

);

 

IOXConfigure is called when a dialog should be displayed allowing viewing or editing of information and settings specific to the plugin.

 

 

The CONFIGUREPARMSIN structure fields

 

type: Specifies CONFIGURE_PLUGIN, CONFIGURE_PROPERTIES, CONFIGURE_INSETTINGS, or CONFIGURE_OUTSETTINGS.

 

•CONFIGURE_ PLUGIN is called in response to a user action requesting a dialog to allow editing or viewing the plugin’s global configuration.  These are configuration items not specific to an individual event or output action.  Options such as device number, serial port settings, or other global settings should be displayed in the dialog.  A plugin is responsible for retrieving and storing this information to non-volatile memory when the plugin is loaded or unloaded.
•CONFIGURE_PROPERTIES is called in response to a user action requesting a dialog to allow viewing the information about the plugin.  This information should include a description of the plugin as well as the plugin version.CONFIGURE_INSETTINGS is called in response
•CONFIGURE_INSETTINGS is called in response to a user action requesting a dialog to allow editing or viewing the eventString for a particular rule.
•CONFIGURE_OUTSETTINGS is called in response to a user action requesting a dialog to allow editing or viewing the output data for a particular rule output action.

 

wxParent: A pointer to the IOX wxWidgets parent frame.  This pointer can be used to set the dialog parent if the plugin is written using wxWidgets.

 

platformParent: A pointer to the IOX parent window in a platform specific format that can be used to set the dialog parent if the plugin is not written using wxWidgets.

 

eventFilter: Valid in CONFIGURE_INSETTINGS calls.  The current eventFilter character string.  This should be used as the default in the edit box or other controls used to provide a new eventFilter.

 

outData: Valid in CONFIGURE_OUTSETTINGS calls.  The current outData buffer.  This should be used as the default in the edit box or other controls used to provide new outData.

 

 

The CONFIGUREPARMSOUT structure fields

 

eventFilter: Valid in CONFIGURE_INSETTINGS calls.  The new eventFilter string as edited by the user or ‘learned’ by other means through the ShowInSettings dialog.

 

outData: Valid in CONFIGURE_OUTSETTINGS calls.  The new outData buffer as edited by the user or ‘learned’ by other means through the ShowOutSettings dialog.