Event Arguments

The arguments that are passed into an event are generally the same for all events that share the same major ID. This section will list all of the arguments that are passed into each event.

Eclipse Shutdown

There are no arguments for this event.

Adding Resources to Source

This event is triggered for the import/convert process. As each new file is imported, an Incremental Build is triggered on that file to complete the process.

_pvxConstants'Project_Member_Count$: The number of files to be processed for this event.
_pvxConstants'Project_Name$: The name of the project that will be affected by this event.

Full Build

This event is triggered for the automated build process that is used when performing a clean build or when forcing a build of selected files. As each new file is imported, an Incremental Build is triggered on that file to complete the process.

_pvxConstants'Project_Location$: The full path (in the local file system) of the root folder for the project.
_pvxConstants'Project_Member_Count$: The number of files to be processed for this event.
_pvxConstants'Project_Name$: The name of the project that will be affected by this event.

Import / Export Properties

This event is triggered when the user chooses to import or export properties for selected projects in the workspace.

_pvxConstants'Project_List$: The list of projects to be exported or imported.
_pvxConstants'Import_Export_File$: The full path (in the local file system) of the file where the properties will be written.

Incremental Build

This event is triggered for any action that will require that the "compiled" version of a source file must be regenerated.

_pvxConstants'SrcFile$: The full path (in the local file system) to the current source file for this event; this file reference will change if/when a contributed tool modified the source file content.
_pvxConstants'event_SrcFile$: The full path (in the local file system) to the "original" source file for this event.
_pvxConstants'BuildLog$: The full path to a log file for any messages that are generated during the processing of this event. This file has a special format and is used to update the "Errors" and "Warnings" under the 'Problems' tab in the workbench.
_pvxConstants'BuildType$: This is the minor code for the event and is used to identify the type of build that is happening.
_pvxConstants'Dest$: The full path (in the local file system) to the destination file that will be created (or updated) as a result of this event.
_pvxConstants'DomFile$: The full path (in the local file system) to the file that will store the information displayed in the 'Outline' view.
_pvxConstants'isLine_Numbs_Required$: A flag that is used by the build process for ProvideX programs to indicate that the destination program requires line numbers.
_pvxConstants'pkf_Password$: The password to be used to encrypt the ProvideX program that is created.

Incremental Build - Alternate Executable

Each project and resource has a property to identify the ProvideX executable to use when building that resource. If this is different from the executable that was assigned to the plug-in on the ProvideX preference page, the build will use this event as a wrapper around the normal incremental build event. This event will start a RPC-style process that will use the alternate executable to process the normal incremental build event.

_pvxConstants'Builder_Exe$: The full path (in the local file system) of the alternate executable.
_pvxConstants'SrcFile$: The full path (in the local file system) to the current source file for this event; this file reference will change if/when a contributed tool modified the source file content.
_pvxConstants'event_SrcFile$: The full path (in the local file system) to the "original" source file for this event.
_pvxConstants'BuildLog$: The full path to a log file for any messages that are generated during the processing of this event. This file has a special format and is used to update the "Errors" and "Warnings" under the 'Problems' tab in the workbench.
_pvxConstants'BuildType$: This is the minor code for the event and is used to identify the type of build that is happening.
_pvxConstants'Dest$: The full path (in the local file system) to the destination file that will be created (or updated) as a result of this event.
_pvxConstants'DomFile$: The full path (in the local file system) to the file that will store the information displayed in the 'Outline' view.
_pvxConstants'isLine_Numbs_Required$: A flag that is used by the build process for ProvideX programs to indicate that the destination program requires line numbers.
_pvxConstants'pkf_Password$: The password to be used to encrypt the ProvideX program that is created.

Password

This event is triggered when passwords are to be validated or captured for a resource.

_pvxConstants'SrcFile$: The full path (in the local file system) to the source file to be used for this event.
_pvxConstants'pkf_Password$: The password to be validated against the specified source file.

Preference Change

This event is triggered for each preference that is modified.

_pvxConstants'Preference_Property$: The name of the preference property that has been modified.
_pvxConstants'Preference_New_Value$: The new value for this preference.
_pvxConstants'Preference_Old_Value$: The old value for this preference.

Preference Page Button

This event is triggered when the user accepts the modifications to the preference page(s).

_pvxConstants'PageID$: The name of the preference page where the properties were modified.

Run Console

This event is triggered when a user chooses either "Run ProvideX Console" or "Load Program" menu option.