Verwaltete Entsprechungen der Win32 API verwenden

Artikel
08/20/2007

TypeName	UseManagedEquivalentsOfWin32Api
CheckId	CA2205
Kategorie	Microsoft.Usage
Unterbrechende Änderung	NonBreaking

Ursache

Eine Plattformaufrufmethode ist definiert, und in der .NET Framework-Klassenbibliothek existiert eine Methode mit der entsprechenden Funktionalität.

Regelbeschreibung

Mit einer Plattformaufrufmethode wird eine nicht verwaltete DLL-Funktion aufgerufen. Die Aufrufmethode wird mit dem System.Runtime.InteropServices.DllImportAttribute-Attribut bzw. in Visual Basic mit dem Declare-Schlüsselwort definiert. Eine fehlerhaft definierte Plattformaufrufmethode kann zu Laufzeitausnahmen führen. Mögliche Gründe hierfür sind Probleme wie falsch benannte Funktionen, eine fehlerhafte Zuordnung von Datentypen für Parameter und Rückgabewerte sowie fehlerhafte Feldspezifikationen, beispielsweise eine falsche Aufrufkonvention und ein falscher Zeichensatz. Falls die entsprechende verwaltete Methode verfügbar ist, ist ein Aufruf dieser Methode im Allgemeinen einfacher und weniger fehleranfällig als eine Definition oder ein direkter Aufruf der nicht verwalteten Methode. Der Aufruf einer Plattformaufrufmethode kann außerdem zu zusätzlichen Sicherheitsproblemen führen, die behandelt werden müssen.

Behandlung von Verstößen

Um einen Verstoß gegen diese Regel zu beheben, ersetzen Sie den Aufruf der nicht verwalteten Funktion durch einen Aufruf der entsprechenden verwalteten Funktion.

Warnungsausschluss

Schließen Sie eine Warnung dieser Regel aus, wenn die benötigte Funktionalität durch die vorgeschlagene Ersetzungsmethode nicht bereitgestellt wird.

Beispiel

Im folgenden Beispiel wird eine Plattformaufrufmethodendefinition veranschaulicht, die gegen die Regel verstößt. Darüber hinaus werden die Aufrufe der Plattformaufrufmethode und der entsprechenden verwalteten Methode dargestellt.

Imports System
Imports System.Runtime.InteropServices
Imports System.Text

Namespace UsageLibrary

   Class NativeMethods

      Private Sub New()
      End Sub

      ' The following method definitions violate the rule.

      <DllImport("kernel32.dll", CharSet := CharSet.Auto, _ 
         SetLastError := True)> _ 
      Friend Shared Function ExpandEnvironmentStrings _ 
         (lpSrc As String, lpDst As StringBuilder, nSize As Integer) _ 
         As Integer
      End Function

      Friend Declare Auto Function ExpandEnvironmentStrings2 _ 
         Lib "kernel32.dll" Alias "ExpandEnvironmentStrings" _ 
         (lpSrc As String, lpDst As StringBuilder, nSize As Integer) _ 
         As Integer

   End Class

   Public Class UseNativeMethod

      Shared Sub Main()
      
         Dim environmentVariable As String = "%TEMP%"
         Dim expandedVariable As New StringBuilder(100)

         ' Call the unmanaged method.
         NativeMethods.ExpandEnvironmentStrings( _ 
            environmentVariable, _ 
            expandedVariable, _ 
            expandedVariable.Capacity)

         ' Call the unmanaged method.
         NativeMethods.ExpandEnvironmentStrings2( _ 
            environmentVariable, _ 
            expandedVariable, _ 
            expandedVariable.Capacity)

         ' Call the equivalent managed method.
         Environment.ExpandEnvironmentVariables(environmentVariable)

      End Sub

   End Class

End Namespace

using System;
using System.Runtime.InteropServices;
using System.Text;

namespace UsageLibrary
{
   internal class NativeMethods
   {
      private NativeMethods() {}

      // The following method definition violates the rule.
      [DllImport("kernel32.dll", CharSet = CharSet.Auto, 
          SetLastError = true)]
      internal static extern int ExpandEnvironmentStrings(
         string lpSrc, StringBuilder lpDst, int nSize);
   }

   public class UseNativeMethod
   {
      public void Test()
      {
         string environmentVariable = "%TEMP%";
         StringBuilder expandedVariable = new StringBuilder(100);

         // Call the unmanaged method.
         NativeMethods.ExpandEnvironmentStrings(
            environmentVariable, 
            expandedVariable, 
            expandedVariable.Capacity);

         // Call the equivalent managed method.
         Environment.ExpandEnvironmentVariables(environmentVariable);
      }
   }
}