Venice::RegisterApp (Interface: Venice)
 
Registers an application to protect it against updates.
 
void RegisterApp (
    BSTR bsObjectList
)
 
Parameters
bsObjectList
[in] A ';'-separated list providing the names of the objects that are used in your SDK application, e.g. "Dossier;Custm" if you want to use the Dossier and the Custm object.
 
Remarks
This method should be used to prevent customers from installing a new version of Venice that is no longer compatible with your SDK application.
This method should be called after logging on to Venice (Logon).
How does it work?
The name and the version (provided in bsCreatedForVenVer of the Logon method) of the SDK application combined with the list of used objects (bsObjectList) are written to the 'SdkApps' section of ClMain.ini (to be found in <Venice path>\Main).
The list of object names is first checked on validity and may only contain valid names of objects.
 
e.g. RegisterApp ("Dossier;Year;Custm;Sales") for an SDK application created for Venice version 6.01_ (provided in bsCreatedForVenVer the Logon method) with the name 'MySDKApp' (provided in bsAppName the Logon method) will result in the following section in ClMain.ini:
[SdkApps]
MySDKApp=0601;Dossier;Year;Custm;Sales
When a new version of Venice is installed, the Venice setup will check if any SDK applications are registered using objects that are not compatible with the new version. If this is the case, updating the Venice installation will not be allowed.
Following steps must be executed to be able to update the Venice installation:
You should manually delete the necessary 'SdkApps' settings from ClMain.ini.
Then you can update the Venice installation without problems.
Finally, adapt your SDK application, using the new implementation of the objects.
 
See Also
CreateVenice
 
Samples
 
C++
 
// If you use a Dossier-object and a Custm-object in your SDK application...
pVenice->RegisterApp ("Dossier;Custm");

C#
 
// If you use a Dossier-object and a Custm-object in your SDK application...
oVenice.RegisterApp ("Dossier;Custm");

VBS
 
' If you use a Dossier-object and a Custm-object in your SDK application...
oVenice.RegisterApp("Dossier;Custm")

VB.NET
 
' If you use a Dossier-object and a Custm-object in your SDK application...
oVenice.RegisterApp("Dossier;Custm")