Walkthrough: Creating an SDK using C++

Article
05/17/2015

This walkthrough shows how to create a native C++ math library SDK, package the SDK as a Visual Studio Extension (VSIX), and then use it to create an app. The walkthrough is divided into these steps:

Composants requis

You must have Visual Studio 2012 and the Kit de développement logiciel Visual Studio 2012 installed on your machine. You can download the SDK from the Visual Studio Downloads website.

To create the native and Windows Runtime libraries

On the menu bar, choose File, New, Project.
In the list of templates, expand Visual C++, Windows Store, and then select the DLL (Windows Store apps) template. In the Name box, specify NativeMath, and then choose the OK button.

Update NativeMath.h to match the following code.

#pragma once

class __declspec(dllexport) BasicMath 
{
public:
    BasicMath();
    double add(double firstNumber, double secondNumber);
    double subtract(double firstNumber, double secondNumber);
};

Update NativeMath.cpp to match this code:

#include "pch.h"
#include "NativeMath.h"

BasicMath::BasicMath()
{
}

double BasicMath::add(double firstNumber, double secondNumber)
{
    return firstNumber + secondNumber;
}

double BasicMath::subtract(double firstNumber, double secondNumber)
{
    return firstNumber - secondNumber;
}

In Solution Explorer, open the shortcut menu for Solution 'NativeMath', and then choose Add, New Project.
In the list of templates, expand Visual C++, and then select the Windows Runtime Component template. In the Name box, specify NativeMathWRT, and then choose the OK button.

Update Class1.h to match this code:

#pragma once

namespace NativeMathWRT
{
    public ref class BasicMathWinMD sealed
    {
    public:
        BasicMathWinMD(){};
        double multiply(double firstNumber, double secondNumber);
        double divide(double firstNumber, double secondNumber);
    };
}

Update Class1.cpp to match this code:

#include "pch.h"
#include "Class1.h"

using namespace NativeMathWRT;
using namespace Platform;

double BasicMathWinMD::multiply(double firstNumber, double secondNumber)
{
    return firstNumber * secondNumber;
}

double BasicMathWinMD::divide(double firstNumber, double secondNumber)
{
    //for demonstration purposes, just return -1 on divide-by-zero
    if(0 == secondNumber) 
        return -1; 

    return firstNumber / secondNumber;
}

On the menu bar, choose Build, Build Solution.

To create the NativeMathVSIX extension project

In Solution Explorer, open the shortcut menu for Solution ‘NativeMath’, and then choose Add, New Project.
In the list of templates, expand Visual C#, Extensibility, and then select VSIX Package. In the Name box, specify NativeMathVSIX, and then choose the OK button.
When the VSIX manifest designer appears, close it.
In Solution Explorer, open the shortcut menu for source.extension.vsixmanifest, and then choose View Code.

Use the following XML to replace the existing XML.

<?xml version="1.0" encoding="utf-8"?>
<PackageManifest Version="2.0.0" xmlns="https://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="https://schemas.microsoft.com/developer/vsx-schema-design/2011">
  <Metadata>
    <Identity Id="NativeMathVSIX..c6b3cae1-e7e2-4e71-90f6-21017ea0dff5" Version="1.0" Language="en-US" Publisher="MyName" />
    <DisplayName>Native Math SDK</DisplayName>
    <Description>Native Math Library w/ Windows Runtime Additions</Description>
  </Metadata>
  <Installation Scope="Global" AllUsers="true">
    <InstallationTarget Id="Microsoft.ExtensionSDK" TargetPlatformIdentifier="Windows" TargetPlatformVersion="v8.0" SdkName="NativeMathSDK" SdkVersion="1.0" />
  </Installation>
  <Dependencies>
  </Dependencies>
  <Assets>
    <Asset Type="Microsoft.ExtensionSDK" d:Source="File" Path="SDKManifest.xml" />
  </Assets>
</PackageManifest>

In Solution Explorer, open the shortcut menu for the NativeMathVSIX project, and then choose Add, New Item.
In the list of Visual C# Items, expand Data, and then select XML File. In the Name box, specify SDKManifest.xml, and then choose the OK button.

Use this XML to replace the contents of the file:

<?xml version="1.0" encoding="utf-8" ?> 
<FileList
  Identity = "NativeMathSDK, Version=1.0"
  DisplayName = "Native Math SDK"
  MinVSVersion = "11.0"
  AppliesTo = "WindowsAppContainer + (CSharp | VB | VisualC)">
  <File Reference="NativeMathWRT.winmd" Implementation="NativeMathWRT.dll" />
</FileList>

In Solution Explorer, in the NativeMathVSIX project, create this folder structure:

      \DesignTime
            \CommonConfiguration
                  \Neutral
                        \Include
            \Debug
                  \x86
      \Redist
            \Debug
                  \x86
      \References
            \CommonConfiguration
                  \Neutral

In Solution Explorer, open the shortcut menu for Solution ‘NativeMath’, and then choose Open Folder in File Explorer.
In File Explorer, copy \NativeMath\NativeMath.h, and then in Solution Explorer, in the NativeMathVSIX project, paste it in the \DesignTime\CommonConfiguration\Neutral\Include\ folder.

Copy \Debug\NativeMath\NativeMath.lib, and then paste it in the \DesignTime\Debug\x86\ folder.

Copy \Debug\NativeMath\NativeMath.dll and paste it in the \Redist\Debug\x86\ folder.

Copy \Debug\NativeMathWRT\NativeMathWRT.dll and paste it in the \Redist\Debug\x86\ folder.

Copy \Debug\NativeMathWRT\NativeMathWRT.winmd and paste it in the \References\CommonConfiguration\Neutral\ folder.

Copy \Debug\NativeMathWRT\NativeMathWRT.pri and paste it in the \References\CommonConfiguration\Neutral\ folder.

In the \DesignTime\Debug\x86\ folder, create a text file that’s named NativeMathSDK.props, and then paste the following contents in it:

<?xml version="1.0" encoding="utf-8" ?>
<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <NativeMathSDKPath>$(FrameworkSDKRoot)\..\v8.0\ExtensionSDKs\NativeMathSDK\1.0\</NativeMathSDKPath>    
    <IncludePath>$(NativeMathSDKPath)DesignTime\CommonConfiguration\Neutral\Include;$(IncludePath)</IncludePath>
    <LibraryPath>$(NativeMathSDKPath)DesignTime\Debug\x86;$(LibraryPath)</LibraryPath> 
 </PropertyGroup>
 <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
    <Link>
      <AdditionalDependencies>NativeMath.lib;%(AdditionalDependencies)</AdditionalDependencies>
    </Link>
  </ItemDefinitionGroup>
</Project>

On the menu bar, choose View, Other Windows, Properties Window (Keyboard: Choose the F4 key).
In Solution Explorer, select the NativeMathWRT.winmd file. In the Properties window, change the Build Action property to Content, and then change the Include in VSIX property to True.

Repeat this process for the SimpleMath.pri file.

Repeat this process for the NativeMath.Lib file.

Repeat this process for the NativeMathSDK.props file.
In Solution Explorer, select the NativeMath.h file. In the Properties window, change the Include in VSIX property to True.

Repeat this process for the NativeMath.dll file.

Repeat this process for the NativeMathWRT.dll file.

Repeat this process for the SDKManifest.xml file.
On the menu bar, choose Build, Build Solution.
In Solution Explorer, open the shortcut menu for the NativeMathVSIX project, and then choose Open Folder in File Explorer.
In File Explorer, navigate to the \bin\Debug\ folder, and then run NativeMathVSIX.vsix to begin the installation.
Choose the Install button, wait for the installation to finish, and then restart Visual Studio.

To create a sample app that uses the class library

On the menu bar, choose File, New, Project.
In the list of templates, expand Visual C++, Windows Store, and then select Blank App. In the Name box, specify NativeMathSDKSample, and then choose the OK button.
In Solution Explorer, open the shortcut menu for the NativeMathSDKSample project, and then choose References.
On the Common Properties, Framework and References property page, in the list of reference types, expand Windows, and then select Extensions. In the details pane, select the Native Math SDK extension, and then choose the Add New Reference button.
In the Add Reference dialog box, select the Native Math SDK check box, and then choose the OK button.
Display the project properties for NativeMathSDKSample.

The properties that you defined in NativeMathSDK.props were applied when you added the reference. You can verify these properties in the Visual C++ Directories.

In Solution Explorer, open MainPage.xaml, and then use the following XAML to replace its content:

<Page
    xmlns="https://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="https://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:NativeMathSDKSample"
    xmlns:d="https://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="https://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:MyMathButtonUserControl="using:MyMathButtonUserControl"
    x:Class="NativeMathSDKSample.MainPage"
    IsTabStop="false"
    mc:Ignorable="d">

    <Grid Background="{StaticResource ApplicationPageBackgroundThemeBrush}">
        <TextBox x:Name="FirstNumber" HorizontalAlignment="Left" Margin="327,123,0,0" TextWrapping="Wrap" Text="1" VerticalAlignment="Top" Height="84" Width="259" FontSize="48"/>
        <TextBox x:Name="SecondNumber" HorizontalAlignment="Left" Margin="687,123,0,0" TextWrapping="Wrap" Text="1" VerticalAlignment="Top" Height="84" Width="271" FontSize="48"/>
        <Button x:Name="Execute" Content="=" HorizontalAlignment="Left" Margin="478,387,0,0" VerticalAlignment="Top" Height="63" Width="332" Click="Execute_Click"/>
        <RadioButton Name="add" Content="Add" HorizontalAlignment="Left" Margin="273,262,0,0" VerticalAlignment="Top" GroupName="Operation" IsChecked="True"/>
        <RadioButton Name="subtract" Content="Subtract" HorizontalAlignment="Left" Margin="453,262,0,0" VerticalAlignment="Top" GroupName="Operation" IsChecked="False"/>
        <RadioButton Name="multiplyWRT" Content="Multiply (WRT)" HorizontalAlignment="Left" Margin="615,262,0,0" VerticalAlignment="Top" GroupName="Operation" IsChecked="False"/>
        <RadioButton Name="divideWRT" Content="Divide (WRT)" HorizontalAlignment="Left" Margin="891,262,0,0" VerticalAlignment="Top" GroupName="Operation" IsChecked="False"/>
        <TextBlock Name="resultText" HorizontalAlignment="Left" Margin="478,525,0,0" TextWrapping="Wrap" Text="TextBlock" VerticalAlignment="Top" Width="332" Height="70" FontSize="48"/>
    </Grid>
</Page>

Update Mainpage.xaml.h to match this code:

//
// MainPage.xaml.h
// Declaration of the MainPage class.
//

#pragma once

#include "MainPage.g.h"

namespace NativeMathSDKSample
{
    /// <summary>
    /// An empty page that can be used on its own or navigated to within a Frame.
    /// </summary>
    public ref class MainPage sealed
    {
    public:
        MainPage();

    protected:
        virtual void OnNavigatedTo(Windows::UI::Xaml::Navigation::NavigationEventArgs^ e) override;
        virtual void Execute_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e);
    };
}

Update MainPage.xaml.cpp to match this code:

//
// MainPage.xaml.cpp
// Implementation of the MainPage class.
//

#include "pch.h"
#include "MainPage.xaml.h"

#include <sstream>
#include "NativeMath.h"


using namespace NativeMathSDKSample;

using namespace Platform;
using namespace Windows::Foundation;
using namespace Windows::Foundation::Collections;
using namespace Windows::UI::Xaml;
using namespace Windows::UI::Xaml::Controls;
using namespace Windows::UI::Xaml::Controls::Primitives;
using namespace Windows::UI::Xaml::Data;
using namespace Windows::UI::Xaml::Input;
using namespace Windows::UI::Xaml::Media;
using namespace Windows::UI::Xaml::Navigation;

using namespace NativeMathWRT;

// The Blank Page item template is documented at https://go.microsoft.com/fwlink/?LinkId=234238

MainPage::MainPage()
{
    InitializeComponent();
}

/// <summary>
/// Invoked when this page is about to be displayed in a Frame.
/// </summary>
/// <param name="e">Event data that describes how this page was reached.  The Parameter
/// property is typically used to configure the page.</param>
void MainPage::OnNavigatedTo(NavigationEventArgs^ e)
{
}

void NativeMathSDKSample::MainPage::Execute_Click(Platform::Object^ sender, Windows::UI::Xaml::RoutedEventArgs^ e)
{
    double iFirstNumber = _wtof(FirstNumber->Text->Data());
    double iSecondNumber = _wtof(SecondNumber->Text->Data());
    double result = 0;

    BasicMathWinMD^ basicMathWinMD = ref new BasicMathWinMD();
    BasicMath basicMath;

    if(add->IsChecked->Value == true)
    {
        result = basicMath.add(iFirstNumber, iSecondNumber);
    }
    else if(subtract->IsChecked->Value == true)
    {
        result = basicMath.subtract(iFirstNumber, iSecondNumber);
    }
    else if(multiplyWRT->IsChecked->Value == true)
    {
        result = basicMathWinMD->multiply(iFirstNumber, iSecondNumber);
    }
    else if (divideWRT->IsChecked->Value == true)
    {
        result = basicMathWinMD->divide(iFirstNumber, iSecondNumber);
    }

    std::wstringstream s;
    s << result;

    resultText->Text = ref new String(s.str().c_str());
}

Choose the F5 key to run the app.
In the app, enter any two numbers, select an operation, and then choose the = button.

The correct result appears.

This walkthrough showed how to create and use an Extension SDK to call into a Windows Runtime library and a non-Windows Runtime library.

Partager via

Walkthrough: Creating an SDK using C++

Composants requis

To create the native and Windows Runtime libraries

To create the NativeMathVSIX extension project

To create a sample app that uses the class library

Voir aussi

Tâches

Concepts

Ressources supplémentaires