Documentation

In MATLAB, create the function that you want to deploy as a shared library.

This example uses the sample function, called makesquare.m, included in the matlabroot\toolbox\dotnetbuilder\Examples\VSVersion\NET\MagicSquareExample\MagicSquareComp folder, where matlabroot represents the name of your MATLAB installation folder.

function y = makesquare(x)

y = magic(x);

Run the example in MATLAB.

makesquare(5)

ans =

    17    24     1     8    15
    23     5     7    14    16
     4     6    13    20    22
    10    12    19    21     3
    11    18    25     2     9

Open the Library Compiler app.

1. On the toolstrip, select the Apps tab.

2. Click the arrow at the far right of the tab to open the apps gallery.

3. Click Library Compiler.

   Note

   You can also call the libraryCompiler command.

   

In the Type section of the toolstrip, select .NET Assembly from the list.

Specify the MATLAB functions that you want to deploy.

1. In the Exported Functions section of the toolstrip, click the plus (+) button.

2. In the file explorer that opens, locate and select the makesquare.m file.

3. Click Open to select the file and close the file explorer.

   The Library Compiler app adds makesquare.m to the list of files and a minus button appears under the plus button. The Library Compiler app uses the name of the file as the name of the deployment project file (.prj), shown in the title bar, and as the name of the assembly, shown in the first field of the Library Information area. The project file saves all of the deployment settings so that you can re-open the project.

In the Packaging Options section of the toolstrip, verify that the Runtime downloaded from web check box is selected.

This option creates an application installer that automatically downloads the MATLAB Runtime and installs it along with the deployed add-in.

In the top field of Library Information, replace makesquare with MagicSquareComp.

In the Class Name column of the class browser, replace Class1 with MLTestClass.

Click Save to save the project.

Click Package.

The Package window opens while the library is being generated. Select the Open output folder when process completes check box. The packaging process generates a self-extracting file that automatically registers the DLL and unpacks all deployable deliverables.

When the deployment process is complete, a file explorer opens and displays the generated output.

It should contain:

Click Close on the Package window.

Install the .NET assembly and the MATLAB Runtime.

The assembly and the MATLAB Runtime are both installed by the Library Compiler app. The installer is located in the for_redistribution folder of your deployment project. The installer places the .NET assembly on your computer and automatically installs the MATLAB Runtime from the Web, if you do not already have the MATLAB Runtime installed on your system.

You can also download the MATLAB Runtime installer from http://www.mathworks.com/products/compiler/mcr. The generated shared libraries and support files are located in the MATLAB deployment project's for_testing folder.

Open Microsoft^® Visual Studio^®.

Create a new project.

For this example create a C# Console Application called MainApp.

Create a reference to your assembly file MagicSquareComp.dll.

The assembly is located in the application folder created where you installed the component.

Create a reference to the MWArray API. The location of the API within MATLAB Runtime is:

C:\Program Files\MATLAB\MATLAB Runtime\v##\toolbox\dotnetbuilder\bin\win64\version\MWArray.dll

Go to Build > Configuration Manager... and change the platform from Any CPU to x64.

Copy the following C# code into the project and save it.

// Make .NET Namespaces available to your generated component.
using System;

using MagicSquareComp;
using MathWorks.MATLAB.NET.Arrays;


// Initialize your classes before you use them.
namespace MainApp
{
  class Program
  {
    static void Main(string[] args)
    {
      MLTestClass obj = null;
      MWNumericArray input = null;
      MWNumericArray output = null;
      MWArray[] result = null;

      // Because class instantiation and method invocation make their exceptions at run time,
      // you should enclose your code in a try-catch block to handle errors.
      try
      {
        // Instantiate your component class.
        obj = new MLTestClass();

        // Invoke your component.
        input = 5;
        result = obj.makesquare(1, input);

        // Extract the Magic Square you created from the first index of result
        output = (MWNumericArray)result[0];
        
        // print the output.
        Console.WriteLine(output);
      }
      catch
      {
        throw;
      }
   }
  }
}

After you finish writing your code, build and run it with Microsoft Visual Studio.