Erstellen eines Softwareentwicklungskits
Ein Software Development Kit (SDK) ist eine Sammlung von APIs, auf die Sie in Visual Studio als einzelnes Element verweisen können. Das Dialogfeld Referenzmanager listet alle SDKs auf, die für das Projekt relevant sind. Wenn Sie einem Projekt ein SDK hinzufügen, sind die APIs in Visual Studio verfügbar.
Es gibt zwei Arten von SDKs:
Plattform-SDKs sind obligatorische Komponenten für die Entwicklung von Apps für eine Plattform. Beispielsweise ist das Windows 8.1 SDK erforderlich, um Windows 8.x Store-Apps zu entwickeln.
Erweiterungs-SDKs sind optionale Komponenten, die eine Plattform erweitern, aber nicht obligatorisch für die Entwicklung von Apps für diese Plattform sind.
In den folgenden Abschnitten wird die allgemeine Infrastruktur von SDKs und das Erstellen eines Plattform-SDK und eines Erweiterungs-SDK beschrieben.
Plattform-SDKs
Plattform-SDKs sind erforderlich, um Apps für eine Plattform zu entwickeln. Beispielsweise ist das Windows 8.1 SDK zum Entwickeln von Apps für Windows 8.1 erforderlich.
Installation
Alle Plattform-SDKs werden unter HKLM\Software\Microsoft\Microsoft SDKs\[TPI]\v[TPV]\@InstallationFolder = [SDK-Stamm] installiert. Dementsprechend wird das Windows 8.1 SDK unter HKLM\Software\Microsoft\Microsoft SDKs\Windows\v8.1 installiert.
Layout
Plattform-SDKs weisen das folgende Layout auf:
\[InstallationFolder root]
SDKManifest.xml
\References
\[config]
\[arch]
\DesignTime
\[config]
\[arch]
| Node | Beschreibung |
|---|---|
| Ordner Referenzen | Enthält Binärdateien, die APIs enthalten, die codiert werden können. Dazu können Windows-Metadatendateien (WinMD) oder Assemblys gehören. |
| DesignTime-Ordner | Enthält Dateien, die nur zur Vorausführung/Debugzeit benötigt werden. Dazu können XML-Dokumente, Bibliotheken, Header, Toolbox-Entwurfszeit-Binärdateien, MSBuild-Artefakte usw. gehören. XML-Dokumente würden idealerweise in den Ordner \DesignTime eingefügt, aber XML-Dokumente für Verweise werden weiterhin zusammen mit der Referenzdatei in Visual Studio platziert. Das XML-Dokument für eine Referenz\References\[config]\[arch]\sample.dll lautet beispielsweise \References\[config]\[arch]\sample.xml, und die lokalisierte Version dieses Dokuments lautet \References\[config]\[arch]\[locale]\[locale]\sample.xml. |
| Konfigurationsordner | Es können nur drei Ordner vorhanden sein: Debug, Retail und CommonConfiguration. SDK-Autoren können ihre Dateien unter CommonConfiguration platzieren, wenn derselbe Satz von SDK-Dateien verwendet werden soll, unabhängig von der Konfiguration, auf die der SDK-Consumer ausgerichtet ist. |
| Ordner Architektur | Jeder unterstützte Architekturordner kann vorhanden sein. Visual Studio unterstützt die folgenden Architekturen: x86, x64, ARM und neutral. Hinweis: Win32 ordnet x86 zu, und AnyCPU wird neutral zugeordnet. MSBuild sucht nur unter \CommonConfiguration\neutral für Plattform-SDKs. |
| SDKManifest.xml | In dieser Datei wird beschrieben, wie Visual Studio das SDK nutzen soll. Sehen Sie sich das SDK-Manifest für Windows 8.1 an:<FileList DisplayName = "Windows" PlatformIdentity = "Windows, version=8.1" TargetFramework = ".NET for Windows Store apps, version=v4.5.1; .NET Framework, version=v4.5.1" MinVSVersion = "14.0"> <File Reference = "Windows.winmd"> <ToolboxItems VSCategory = "Toolbox.Default" /> </File> </FileList>DisplayName: Der Wert, den der Objektbrowser in der Liste Durchsuchen anzeigt. PlatformIdentity: Das Vorhandensein dieses Attributs weist Visual Studio und MSBuild darauf hin, dass das SDK ein Plattform-SDK ist und dass die daraus hinzugefügten Verweise nicht lokal kopiert werden sollten. TargetFramework: Dieses Attribut wird von Visual Studio verwendet, um sicherzustellen, dass nur Projekte, die auf dieselben Frameworks abzielen, wie im Wert dieses Attributs angegeben, das SDK verwenden können. MinVSVersion: Dieses Attribut wird von Visual Studio verwendet, um nur die SDKs zu nutzen, die darauf angewendet werden. Verweis: Dieses Attribut darf nur für Verweise angegeben werden, die Steuerelemente enthalten. Informationen zum Angeben, ob ein Verweis Steuerelemente enthält, finden Sie unten. |
Erweiterungs-SDKs
In den folgenden Abschnitten wird beschrieben, was Sie tun müssen, um ein Erweiterungs-SDK bereitzustellen.
Installation
Erweiterungs-SDKs können für einen bestimmten Benutzer oder für alle Benutzer installiert werden, ohne einen Registrierungsschlüssel anzugeben. Verwenden Sie den folgenden Pfad, um ein SDK für alle Benutzer zu installieren:
%Program Files%\Microsoft SDKs<target platform>\v<platform version number>\ExtensionSDKs
Verwenden Sie für eine benutzerspezifische Installation den folgenden Pfad:
%USERPROFILE%\AppData\Local\Microsoft SDKs-Zielplattform<>\v<Plattformversionsnummer>\ExtensionSDKs
Wenn Sie einen anderen Speicherort verwenden möchten, müssen Sie eine von zwei Dingen ausführen:
Geben Sie ihn in einem Registrierungsschlüssel an:
HKLM\Software\Microsoft\Microsoft SDKs-Zielplattform<>\v<Plattformversionsnummer>\ExtensionSDKs<SDKName><SDKVersion>\
und fügen Sie einen (Standard)-Unterschlüssel hinzu, der einen Wert aufweist
<path to SDK><SDKName><SDKVersion>.Fügen Sie die MSBuild-Eigenschaft
SDKReferenceDirectoryRootin Ihre Projektdatei hinzu. Der Wert dieser Eigenschaft ist eine durch Semikolons getrennte Liste von Verzeichnissen, in denen sich die Erweiterungs-SDKs befinden, auf die Sie verweisen möchten.
Installationslayout
Erweiterungs-SDKs weisen das folgende Installationslayout auf:
\<ExtensionSDKs root>
\<SDKName>
\<SDKVersion>
SDKManifest.xml
\References
\<config>
\<arch>
\Redist
\<config>
\<arch>
\DesignTime
\<config>
\<arch>
\<SDKName>\<SDKVersion>: Der Name und die Version des Erweiterungs-SDK werden von den entsprechenden Ordnernamen im Pfad zum SDK-Stamm abgeleitet. MSBuild verwendet diese Identität, um das SDK auf dem Datenträger zu finden, und Visual Studio zeigt diese Identität im Dialogfeld Eigenschaften und im Dialogfeld Verweis-Manager an.
Ordner Verweise: die Binärdateien, die die APIs enthalten. Hierbei kann es sich um Windows-Metadatendateien (WinMD) oder Assemblys handeln.
Ordner Redist: Die Dateien, die zum Laufzeit-/Debuggen benötigt werden, und sollten als Teil der Anwendung des Benutzers verpackt werden. Alle Binärdateien sollten unter \redist\<config>\<arch> platziert werden, und die Binären Namen sollten das folgende Format aufweisen, um die Eindeutigkeit sicherzustellen: ]<company>.<Produkt>.<Zweck>.<Erweiterung>. Beispiel: *Microsoft.Cpp.Build.dll. Alle Dateien mit Namen, die mit Dateinamen aus anderen SDKs kollidieren können (z. B. Javascript, css, pri, xaml, png und jpg-Dateien) sollten unter \redist\<config>\<arch>\<sdkname>* platziert werden, mit Ausnahme der Dateien, die XAML-Steuerelementen zugeordnet sind. Diese Dateien sollten unter *\redist\<config>\<arch>\<componentname>\platziert werden.
DesignTime-Ordner: Die Dateien, die nur zur Vorausführungs-/Debuggingzeit benötigt werden und nicht als Teil der Anwendung des Benutzers verpackt werden sollten. Dies können XML-Dokumente, Bibliotheken, Header, Toolbox-Entwurfszeit-Binärdateien, MSBuild-Artefakte usw. sein. Jedes SDK, das für die Verwendung durch ein systemeigenes Projekt vorgesehen ist, muss über eine SDKName.props-Datei verfügen. Im Folgenden finden Sie ein Beispiel für diesen Dateityp.
<?xml version="1.0" encoding="utf-8"?> <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <PropertyGroup> <ExecutablePath>C:\Temp\ExecutablePath;$(ExecutablePath)</ExecutablePath> <IncludePath>$(FrameworkSDKRoot)\..\v8.1\ExtensionSDKs\cppimagingsdk\1.0\DesignTime\CommonConfiguration\Neutral\include;$(IncludePath)</IncludePath> <AssemblyReferencePath>C:\Temp\AssemblyReferencePath;(AssemblyReferencePath)</AssemblyReferencePath> <LibraryPath>$(FrameworkSDKRoot)\..\v8.1\ExtensionSDKs\cppimagingsdk\1.0\DesignTime\Debug\ARM;$(LibraryPath)</LibraryPath> <SourcePath>C:\Temp\SourcePath\X64;$(SourcePath)</SourcePath> <ExcludePath>C:\Temp\ExcludePath\X64;$(ExcludePath)</ExcludePath> <_PropertySheetDisplayName>DevILSDK, 1.0</_PropertySheetDisplayName> </PropertyGroup> </Project>XML-Referenzdokumente werden zusammen mit der Referenzdatei platziert. Beispielsweise lautet das XML-Referenzdokument für die Assembly \References\<config>\<arch>\sample.dll\References\<config>\<arch>\sample.xml, und die lokalisierte Version dieses Dokuments lautet \References\<config>\<arch>\<locale>\sample.xml.
Konfigurationsordner: drei Unterordner: Debuggen, Einzelhandel und CommonConfiguration. SDK-Autoren können ihre Dateien unter CommonConfiguration platzieren, wenn derselbe Satz von SDK-Dateien verwendet werden soll, unabhängig von der Konfiguration, die vom SDK-Consumer verwendet werden soll.
Architekturordner: Die folgenden Architekturen werden unterstützt: x86, x64, ARM, neutral. Win32 ordnet x86 zu, und AnyCPU wird neutral zugeordnet.
SDKManifest.xml
Die SDKManifest.xml Datei beschreibt, wie Visual Studio das SDK nutzen soll. Es folgt ein Beispiel:
<FileList DisplayName = "My SDK"
ProductFamilyName = "My SDKs"
TargetFramework = ".NETCore, version=v4.5.1; .NETFramework, version=v4.5.1"
MinVSVersion = "14.0"
MaxPlatformVersion = "8.1"
AppliesTo = "WindowsAppContainer + WindowsXAML"
SupportPrefer32Bit = "True"
SupportedArchitectures = "x86;x64;ARM"
SupportsMultipleVersions = "Error"
CopyRedistToSubDirectory = "."
DependsOn = "SDKB, version=2.0"
MoreInfo = "https://msdn.microsoft.com/MySDK">
<File Reference = "MySDK.Sprint.winmd" Implementation = "XNASprintImpl.dll">
<Registration Type = "Flipper" Implementation = "XNASprintFlipperImpl.dll" />
<Registration Type = "Flexer" Implementation = "XNASprintFlexerImpl.dll" />
<ToolboxItems VSCategory = "Toolbox.Default" />
</File>
</FileList>
Die folgende Liste enthält die Elemente der Datei:
DisplayName: Der Wert, der im Verweis-Manager angezeigt wird, Projektmappen-Explorer, Objektbrowser und andere Speicherorte in der Benutzeroberfläche für Visual Studio.
ProductFamilyName: Der allgemeine SDK-Produktname. Beispielsweise heißt das Windows Library for JavaScript (WinJS) SDK „Microsoft.WinJS.1.0“ und „Microsoft.WinJS.2.0“, die zur gleichen Familie von SDK-Produkten gehören, „Microsoft.WinJS“. Mit diesem Attribut kann Visual Studio und MSBuild diese Verbindung herstellen. Wenn dieses Attribut nicht vorhanden ist, wird der SDK-Name als Produktfamilienname verwendet.
FrameworkIdentity: Gibt eine Abhängigkeit von einer oder mehreren Windows-Komponentenbibliotheken an. Der Wert dieses Attributs wird in das Manifest der verbrauchenden App eingefügt. Dieses Attribut gilt nur für Windows-Komponentenbibliotheken.
TargetFramework: Gibt die SDKs an, die im Verweis-Manager und in der Toolbox verfügbar sind. Dies ist eine durch Semikolons getrennte Liste von Zielframework-Monikern, z. B. „.NET Framework, version=v2.0; .NET Framework, version=v4.5.1“. Wenn mehrere Versionen desselben Zielframeworks angegeben sind, verwendet der Verweis-Manager die niedrigste angegebene Version für Filterzwecke. Wenn z. B. „.NET Framework, version=v2.0; .NET Framework, version=v4.5.1“ angegeben ist, verwendet der Verweis-Manager „.NET Framework, version=v2.0“. Wenn ein bestimmtes Zielframeworkprofil angegeben ist, wird nur dieses Profil vom Verweis-Manager für Filterzwecke verwendet. Wenn beispielsweise „Silverlight, version=v4.0, profile=Windows-Telefon“ angegeben wird, filtert der Verweis-Manager nur auf das Windows Telefon-Profil; Ein Projekt, das auf das vollständige Silverlight 4.0 Framework abzielt, wird das SDK nicht im Verweis-Manager angezeigt.
MinVSVersion: Die minimale Visual Studio-Version.
MaxPlatformVerson: Die maximale Zielplattformversion sollte verwendet werden, um die Plattformversionen anzugeben, auf denen Ihr Erweiterungs-SDK nicht funktioniert. Beispielsweise sollte auf das Microsoft Visual C++-Runtime-Paket v11.0 nur von Windows 8-Projekten verwiesen werden. Daher ist die MaxPlatformVersion des Windows 8-Projekts 8.0. Dies bedeutet, dass der Verweis-Manager microsoft Visual C++-Runtime-Paket für ein Windows 8.1-Projekt herausfiltert und MSBuild einen Fehler auslöst, wenn ein Windows 8.1-Projekt darauf verweist. Hinweis: Dieses Element wird ab Visual Studio 2013 unterstützt.
AppliesTo: Gibt die SDKs an, die im Verweis-Manager verfügbar sind, indem Sie entsprechende Visual Studio-Projekttypen angeben. Neun Werte werden erkannt: WindowsAppContainer, VisualC, VB, CSharp, WindowsXAML, JavaScript, Managed und Native. Der SDK-Autor kann und („+“) oder („|“), nicht („!“) Operatoren, um genau den Umfang der Projekttypen anzugeben, die für das SDK gelten.
WindowsAppContainer identifiziert Projekte für Windows 8.x Store-Apps.
SupportPrefer32Bit: Unterstützte Werte sind „True“ und „False“. Der Standardwert ist „True“. Wenn der Wert auf „False“ festgelegt ist, gibt MSBuild einen Fehler für Windows 8.x Store-Projekte (oder eine Warnung für Desktopprojekte) zurück, wenn das Projekt, das auf das SDK verweist, Prefer32Bit aktiviert ist. Weitere Informationen zu Prefer32Bit finden Sie auf der Seite Build, Project Designer (C#) oder Kompilieren, Project Designer (Visual Basic).
SupportedArchitectures: Eine durch Semikolons getrennte Liste der Architekturen, die das SDK unterstützt. MSBuild zeigt eine Warnung an, wenn die zielorientierte SDK-Architektur im verbrauchenden Projekt nicht unterstützt wird. Wenn dieses Attribut nicht angegeben ist, zeigt MSBuild niemals diesen Warnungstyp an.
SupportsMultipleVersions: Wenn dieses Attribut auf Error oder Warning festgelegt ist, gibt MSBuild an, dass dasselbe Projekt nicht auf mehrere Versionen derselben SDK-Familie verweisen kann. Wenn dieses Attribut nicht vorhanden ist oder auf Zulassen festgelegt ist, zeigt MSBuild diesen Fehler- oder Warnungstyp nicht an.
AppX: Gibt den Pfad zu den App-Paketen für die Windows-Komponentenbibliothek auf dem Datenträger an. Dieser Wert wird während des lokalen Debuggens an die Registrierungskomponente der Windows-Komponentenbibliothek übergeben. Die Benennungskonvention für den Dateinamen lautet <Company>.<Produkt>.<Architektur>.<Konfiguration>.<Version>.appx. Die Konfiguration und Architektur sind im Attributnamen und dem Attributwert optional, wenn sie nicht für die Windows-Komponentenbibliothek gelten. Dieser Wert gilt nur für Windows-Komponentenbibliotheken.
CopyRedistToSubDirectory: Gibt an, wo die Dateien im Ordner \redist relativ zum App-Paketstamm kopiert werden sollen (d. h. der im Assistenten zum Erstellen von App-Paketen ausgewählte Paketspeicherort) und dem Laufzeitlayoutstamm. Der Standardspeicherort ist der Stamm des App-Pakets und des F5-Layouts.
DependsOn: Eine Liste der SDK-Identitäten, die die SDKs definieren, von denen dieses SDK abhängt. Dieses Attribut wird im Detailbereich des Verweis-Managers angezeigt.
MoreInfo: Die URL zur Webseite, die Hilfe und weitere Informationen bereitstellt. Dieser Wert wird im link Weitere Informationen im rechten Bereich des Verweis-Managers verwendet.
Registrierungstyp: Gibt die WinMD-Registrierung im App-Manifest an und ist für systemeigene WinMD erforderlich, die über eine Gegenstückimplementierungs-DLL verfügt.
Dateireferenz: Nur für Verweise angegeben, die Steuerelemente enthalten oder systemeigene WinMDs sind. Informationen zum Angeben, ob ein Verweis Steuerelemente enthält, finden Sie unter Angeben des Speicherorts der Toolboxelemente unten.
Angeben des Speicherorts von Toolboxelementen
Das ToolBoxItems-Element des SDKManifest.xml Schemas gibt die Steuerelementnamen, Quellassemblies und Toolboxregisterkartennamen von Toolboxelementen in Plattform- und Erweiterungs-SDKs an. Die folgenden Beispiele zeigen verschiedene Szenarien. Dies gilt entweder für WinMD- oder DLL-Verweise.
Beachten Sie, dass Visual Studio 2019 und früher anstelle der Auflistung von Toolbox-Steuerelementnamen im Manifest visual Studio die Steuerelementtypen in den Assemblys des SDK dynamisch auflisten. Ab Visual Studio 2022 wird dies nicht mehr unterstützt. Toolboxelemente müssen in SDKManifest.xml explizit aufgeführt werden.
Platzieren Sie Steuerelemente in der Toolbox-Standardkategorie.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Toolbox.Default"> <Item Type = "Namespace.ControlName1" /> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Platzieren Sie Steuerelemente unter einem bestimmten Kategorienamen.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory= "MyCategoryName"> <Item Type = "Namespace.ControlName1" /> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Platzieren Sie Steuerelemente unter bestimmten Kategorienamen.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Graph"> <Item Type = "Namespace.ControlName1" /> </ToolboxItems> <ToolboxItems VSCategory = "Data"> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Platzieren Sie Steuerelemente unter verschiedenen Kategorienamen in Blend und Visual Studio.
// Blend accepts a slightly different structure for the category name because it allows a path rather than a single category. <File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Graph" BlendCategory = "Controls/sample/Graph"> <Item Type = "Namespace.ControlName1" /> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Aufzählen bestimmter Steuerelemente in Blend und Visual Studio unterschiedlich.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Graph"> <Item Type = "Namespace.ControlName1" /> </ToolboxItems> <ToolboxItems BlendCategory = "Controls/sample/Graph"> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Aufzählen Sie bestimmte Steuerelemente, und platzieren Sie sie unter dem allgemeinen Pfad von Visual Studio oder nur in der Gruppe Alle Steuerelemente.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Toolbox.Common"> <Item Type = "Namespace.ControlName1" /> </ToolboxItems> <ToolboxItems VSCategory = "Toolbox.All"> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>Aufzählen bestimmter Steuerelemente und Anzeigen nur eines bestimmten Satzes in ChooseItems, ohne dass sie in der Toolbox enthalten sind.
<File Reference = "sample.winmd"> <ToolboxItems VSCategory = "Toolbox.ChooseItemsOnly"> <Item Type = "Namespace.ControlName1" /> <Item Type = "Namespace.ControlName2" /> </ToolboxItems> </File>