Dict_UpdateFormsDictionary()

The Dict_UpdateFormsDictionary() function updates a forms dictionary to work with the new version of your application. This function attempts to preserve the modifications made to the forms in the forms dictionary.

Syntax

Dict_UpdateFormsDictionary(main_product_dictionary, previous_application_dictionary, new_application_dictionary, forms_dictionary, exception_script, progress_script)

Parameters

• main_product_dictionary – A string containing the complete path, in generic format, to the main product dictionary. If the forms dictionary being updated isn’t part of a product that integrates with a main product like Microsoft Dynamics GP, set this parameter to the empty string (""). If the forms dictionary being updated is part of a product that integrates with Microsoft Dynamics GP, set this parameter to the path to the Dynamics.dic dictionary.

• previous_application_dictionary – A string containing the complete path, in generic format, to the previous version of the application dictionary.

• new_application_dictionary – A string containing the complete path, in generic format, to the new version of the application dictionary.

• forms_dictionary – A string containing the complete path, in generic format, to the forms dictionary being updated.

• exception_script – A form-level procedure that is called when exceptions are encountered during the update process.

• progress_script – A form-level procedure that is called to indicate the progress of the update process.

Return value

An integer corresponding to one of the following constants:

Constant	Description
STATUS_SUCCESS	No error occurred.
STATUS_PRIMARY_DICT_MISSING	Unable to open main product dictionary.
STATUS_OLD_PROD_DICT_MISSING	Unable to open previous application dictionary.
STATUS_NEW_PROD_DICT_MISSING	Unable to open new application dictionary.
STATUS_FORM_DICT_MISSING	Unable to open forms dictionary.
STATUS_VERSION_INCOMPATIBLE	The forms dictionary is not compatible with the previous application dictionary.
STATUS_ERROR	An unknown error occurred.

Comments

The updating operation performed by this function is also performed automatically during the unchunking process.

The exception script is a form-level procedure that is called each time an exception occurs during the update process. Typically, you will save the exception information to a log file. This procedure must have the following parameters:

source_file – A string in parameter containing the name of the source file being processed when the exception occurred.
phase – A string in parameter containing the name of the phase being executed when the exception occurred.
error_text – A string in parameter describing the exception that occurred.
resource_type – A string in parameter identifying the type of resource for which the exception occurred.
resource_name – A string in parameter identifying the resource for which the exception occurred.

The progress script is a form-level procedure that is called periodically during the update process. This procedure must have the following parameters:

total_phases – An integer in parameter containing the total number of phases needed to complete the update process.
current_phase – An integer in parameter indicating the phase currently being processed.
total_steps – An integer in parameter containing the total number of steps needed to complete the current phase.
current_step – An integer in parameter indicating the step currently being processed.
source_file – A string in parameter containing the name of the source file currently being processed.
phase – A string in parameter containing the name of the phase currently being processed.