This topic provides technical details on embedding license information into your applications. This is a special resource that must be present in every application that uses dotConnect for MySQL.
|License information discussed in this topic is not same thing as license for using dotConnect for MySQL. License purchased on our site allows you, your team, or your company to use dotConnect for MySQL. For information on how to purchase license for using dotConnect for MySQL please refer to topic Ordering.|
The article consists of following sections:
- General Information
- Licensing .NET Standard (.NET Core) Projects
- Adding License Automatically
- Adding License Manually
- Class Libraries Support
- Licensing ASP.NET Applications
- Licensing Compact Framework Projects
- DbProviderFactory Notes
- Compiling License Manually
- Licensing Mono Projects
dotConnect for MySQL uses .NET component licensing. To build an application dotConnect for MySQL requires valid license. If no license is available, dotConnect for MySQL does not work.
License information is a specially formed embedded resource. Usually you do not have to care about embedding license in your application. When you install dotConnect for MySQL, the system is configured so that licensing is done transparently. End-users of your software do not require any additional license.
dotConnect for MySQL includes License Wizard that helps you configure license information. The wizard analyzes the current project, informs you about problems found, and performs some actions needed to fix the problems.
To invoke the wizard choose MySQL | License Information from the Visual Studio Tools menu. Then click the Fix buttons in the dialog and follow the wizard's instructions. In most cases this is enough to configure .NET component licensing.
The following table helps get started quickly with dotConnect for MySQL licensing. Find your type of application and follow links to corresponding sections of the article.
|This is general case of licensed .NET Framework application. Whatever the type of application you develop, read carefully sections Adding License Automatically and Adding License Manually.|
|These two diagrams show how you can use dotConnect for MySQL through a class library. In addition to Adding License Automatically and Adding License Manually please read section Class Libraries Support.|
|These are two modes of accessing dotConnect for MySQL within ASP.NET application. In addition to Adding License Automatically and Adding License Manually please read section Licensing ASP.NET Applications.|
|Some applications that have no licensing information embedded, and use DbProviderFactory to operate dotConnect for MySQL, require the product installed on the computer. Refer to section DbProviderFactory Notes for more information.|
.NET Standard compatible assemblies of the dotConnect for MySQL use a different licensing mechanism. For .NET Standard (.NET Core) projects you must add the license key either as a connection string parameter or as a file to the C:\ProgramData\Devart\dotConnect\License\ folder. For more information read the Licensing .NET Standard (.NET Core) Projects topic.
License is automatically added to project when you drop a MySqlConnection component from Toolbox onto a form designer.
Under .NET Compact Framework, in the moment of compilation license information is automatically added if the dotConnect for MySQL addin for Visual Studio is running.
In some cases you have to manually add license. It is necessary for console applications, class libraries, and existing projects initially built with dotConnect for MySQL version that did not use component licensing, that is, 3.20 and older. In this case perform the following steps:
- Create a file named licenses.licx, if this file does not exist yet.
- Open the file with a text editor and place this line inside:
- Save the file and add it to your project.
- Make sure it is embedded as a resource.
If IDE fails to compile the license automatically, you can do it yourself as described in section Compiling License Manually.
In case where it is impossible to put the license information straight to executable file, dotConnect for MySQL allows you to create class libraries that can be used with certain executable files. To do this perform the following steps:
- Create and setup file named licenses.licx as described above.
- Create a text file named licenses.config and place it next to licenses.licx.
- In this file enumerate names of executable files that will work with the library,
every file name on separate line, for example:
You do not have to add the file licenses.config to project.
There are two types of web projects depending on the type of licensing.
- First, Web Application Project (Web Forms, MVC, Web API, etc.) are compiled entirely, so that web server does not perform any compilation on demand. In this case licensing web applications is same as licensing common Class Library applications.
- Second, there are Web Site Projects, when source files are uploaded to server, where they are compiled on user request. In this case you should deploy a special assembly App_Licenses.dll to the Bin directory of your site for the Web Site projects. To create this assembly, right-click the licenses.licx file in the Solution Explorer view and then click Build Runtime Licenses. The required assembly will be created automatically. Note that the corresponding shortcut menu command is available when the licenses.licx file is located in the root folder of the site.
For .NET Compact Framework the Visual Studio add-in automatically embeds all required information into every assembly that uses Devart.Data.MySql.dll library. Class libraries are supported automatically.
If the license fails to be added to a project, you can add and compile it manually. Note that there is no license compiler from Microsoft for .NET Compact Framework. You can request the compiler from Devart support team.
There is a known problem with the .NET Compact Framework. A "License not found" exception can be thrown by MySqlDataAdapter.Fill method in case when MySqlConnection had never been opened. To avoid the problem just open (or open and close) any connection before calling the MySqlDataAdapter.Fill method.
Applications that call dotConnect for MySQL through DbProviderFactory require registration in DbProviderFactory. This registration can be performed either by launching installer of dotConnect for MySQL with the Minimal install type (the licenses.licx file is not required in this case), or manually as it is described in the Deployment topic. DbProviderFactory support allows using dotConnect for MySQL in SQL Server 2008/2012 Business Intelligence Solutions.
The license resource cannot be compiled automatically when your project does not have reference to Devart.Data.MySql.dll or dotConnect for MySQL is not installed on your build server. This section describes how to compile the required resource manually.
Generate licensing resource file using following command line:
"%Compiler Path%\lc.exe" /target:MyApplication.exe /complist:licenses.licx /i:"%Assembly Path%\Devart.Data.MySql.dll"
- %Compiler Path% is a path to appropriate lc.exe file (for example, C:\Program Files\Microsoft.NET\SDK\v2.0\Bin);
- MyApplication.exe is name of your target executable file;
- licenses.licx is a text file described earlier in this topic;
- %Assembly Path% is location of Devart.Data.MySql.dll assembly
Devart.Data.MySql.MySqlConnection, Devart.Data.MySql, Version=18.104.22.168, Culture=neutral, PublicKeyToken=09af7300eec23701
License compiler will generate 'MyApplication.exe.licenses' resource file. You should add this file to your project as an embedded resource. Note that you should not add licenses.licx to the project because the *.licenses file already includes all the necessary license information.
If the default namespace of your project is not an empty string, it must be the same as the target assembly name (in this case - 'MyApplication'). IDE adds the default namespace to the resource name when building application, so you have to rename 'MyApplication.exe.licenses' to 'exe.licenses' before adding it to project. If the default namespace of your project is not set (is an empty string) you do not have to rename the resource file before adding it to project.
You can also generate the license resource manually for the class library assembly (*.dll) in the same way. Just place licenses.config in the folder with your licenses.licx (and change /target:MyApplication.exe to /target:YourClassLibraryName.dll).
When something's wrong with license information you get one of the following exceptions on connecting to server:
|Exception text||Possible reasons and what to do|
License not found...
This generally indicates that license information could not be found, or you try to apply it in some way that does not suit the kind of application. For example:
To fix the problem determine type of your application and read corresponding section in this topic.
This exception can be thrown by MySqlDataAdapter.Fill method under .NET Compact Framework, in case when MySqlConnection had never been opened. To avoid the problem just open (or open and close) any connection before calling the MySqlDataAdapter.Fill method.
License not valid...
This means that license information was found but it is incorrect. It usually happens in the following cases:
If you encounter one of these problems, do the following (the numbers of actions correspond to the numbers of the problems in the above list):
If this does not help, send a small compiled binary with sources to our support address, so we can investigate the problem in more details.
Sorry, your trial period has expired...
This exception indicates that you used trial version of dotConnect for MySQL, and the 30 days trial period is expired. To continue using dotConnect for MySQL register it or uninstall from your machine.
You can also see this message if the application was compiled with registered version of dotConnect for MySQL, but deployed with trial assembly Devart.Data.MySql.dll. If this is the case, replace old files with latest assemblies.