Deletes the archived data for a specified table of an extension during installation.
Specifies the ID of the extension table whose archive data you want to delete.
true, if the archived data was deleted for the specified table; otherwise false.
If you omit this optional return value and if archived data cannot be deleted for the specified table, then a run-time error occurs. If you include a return value, then it is assumed that you will handle any errors and no run-time error occurs, even though the archived data is not deleted.
You use this function as part of the upgrade code for an extension, where it is called from the
OnNavAppUpgradePerCompany() system functions. When an extension is uninstalled, the data in application tables of the extension is automatically stored into a set of special tables so that the data is still preserved. With the DELETEARCHIVEDATA function, you can delete the archived data from the application table of the new version of an extension when it is installed. For more information and sample code, see Upgrading Extensions and How to: Write Extension Upgrade Code.