DllImportAttribute.PreserveSig Pole

Definicja

Przestrzeń nazw:

System.Runtime.InteropServices

Zestaw:

System.Runtime.InteropServices.dll

Źródło:

DllImportAttribute.cs

Wskazuje, czy niezarządzane metody, które mają HRESULT zwracane wartości, są tłumaczone bezpośrednio, czy HRESULT zwracane wartości są automatycznie konwertowane na wyjątki.

public: bool PreserveSig;

public bool PreserveSig;

val mutable PreserveSig : bool

Public PreserveSig As Boolean 

Wartość pola

Boolean

Przykłady

W poniższym przykładzie kodu użyto elementu , DllImportAttribute aby zaimportować funkcję niezarządzaną SHAutoComplete raz z PreserveSig polem ustawionym na true wartość i ponownie z polem ustawionym PreserveSig na falsewartość . Ten przykład kodu powoduje, SHAutoComplete że funkcja generuje błędy z wyjątkiem jednorazowo i następnym HRESULT .

using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;

internal class Win32
{
    // The SHAutoComplete function allows you
    // to add auto-compete functionality to your
    // Windows Forms text boxes. In .NET Framework
    // 1.1 and earlier, you can use SHAutoComplete.
    // Later versions have this ability built in without
    // requiring platform invoke.

    // See the MSDN documentation of the
    // SHAutoComplete function for the
    // complete set of flags.
    public enum SHAutoCompleteFlags
    {
        SHACF_DEFAULT = 0x00000000,
        SHACF_FILESYSTEM = 0x00000001
    }

    // Use the DllImportAttribute to import the SHAutoComplete function.
    // Set the PreserveSig to false to specify exception errors.
    [DllImportAttribute("shlwapi.dll", EntryPoint = "SHAutoComplete", ExactSpelling = true, PreserveSig = false)]
    public static extern void SHAutoComplete(IntPtr hwndEdit, SHAutoCompleteFlags dwFlags);

    // Use the DllImportAttribute to import the SHAutoComplete function.
    // Use the default value of the PreserveSig field to specify HRESULT errors.
    [DllImportAttribute("shlwapi.dll", EntryPoint = "SHAutoComplete", ExactSpelling = true)]
    public static extern int SHAutoCompleteHRESULT(IntPtr hwndEdit, SHAutoCompleteFlags dwFlags);
}

static class Program
{
    static void Main()
    {
        Run();
    }

    static void Run()
    {
        // Create a null (nothing in Visual Basic) IntPtr
        // to pass to the SHAutoComplete method.  Doing so
        // creates a failure and demonstrates the two ways
        // that the PreserveSig property allows you to handle
        // failures.
        // Normally, you would pass a handle to a managed
        // Windows Forms text box.
        IntPtr iPtr = new IntPtr(0);

        // Call the SHAutoComplete function using exceptions.
        try
        {
            Console.WriteLine("Calling the SHAutoComplete method with the PreserveSig field set to false.");

            Win32.SHAutoComplete(iPtr, Win32.SHAutoCompleteFlags.SHACF_DEFAULT);
        }
        catch (Exception e)
        {
            Console.WriteLine("Exception handled: " + e.Message);
        }

        Console.WriteLine("Calling the SHAutoComplete method with the PreserveSig field set to true.");

        // Call the SHAutoComplete function using HRESULTS.
        int HRESULT = Win32.SHAutoCompleteHRESULT(iPtr, Win32.SHAutoCompleteFlags.SHACF_DEFAULT);

        Console.WriteLine("HRESULT handled: " + HRESULT.ToString());
    }
}

Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Runtime.InteropServices



Module Win32
    ' The SHAutoComplete function allows you 
    ' to add auto-compete functionality to your
    ' Windows Forms text boxes. In .NET Framework 
    ' 1.1 and earlier, you can use SHAutoComplete.
    ' Later versions have this ability built in without
    ' requiring platform invoke.
    ' See the MSDN documentation of the 
    ' SHAutoComplete function for the 
    ' complete set of flags.

    Public Enum SHAutoCompleteFlags
        SHACF_DEFAULT = &H1
        SHACF_FILESYSTEM = &H1
    End Enum 


    ' Use the DllImportAttribute to import the SHAutoComplete function. 
    ' Set the PreserveSig to false to specify exception errors.
    <DllImportAttribute("shlwapi.dll", EntryPoint:="SHAutoComplete", ExactSpelling:=True, PreserveSig:=False)> _
    Public Sub SHAutoComplete(ByVal hwndEdit As IntPtr, ByVal dwFlags As SHAutoCompleteFlags)
    End Sub


    ' Use the DllImportAttribute to import the SHAutoComplete function. 
    ' Use the default value of the PreserveSig field to specify HRESULT errors.
    <DllImportAttribute("shlwapi.dll", EntryPoint:="SHAutoComplete", ExactSpelling:=True)> _
    Public Function SHAutoCompleteHRESULT(ByVal hwndEdit As IntPtr, ByVal dwFlags As SHAutoCompleteFlags) As Integer
    End Function
End Module



Module Program

    Sub Main()
        Run()

    End Sub


    Sub Run()
        ' Create a null (nothing in Visual Basic) IntPtr
        ' to pass to the SHAutoComplete method.  Doing so
        ' creates a failure and demonstrates the two ways  
        ' that the PreserveSig property allows you to handle 
        ' failures.  
        ' Normally, you would pass a handle to a managed
        ' Windows Forms text box.
        Dim iPtr As New IntPtr(0)

        ' Call the SHAutoComplete function using exceptions.
        Try
            Console.WriteLine("Calling the SHAutoComplete method with the PreserveSig field set to false.")

            Win32.SHAutoComplete(iPtr,Win32.SHAutoCompleteFlags.SHACF_DEFAULT)
        Catch e As Exception
            Console.WriteLine("Exception handled: " + e.Message)
        End Try

        Console.WriteLine("Calling the SHAutoComplete method with the PreserveSig field set to true.")

        ' Call the SHAutoComplete function using HRESULTS.
        Dim HRESULT As Integer = Win32.SHAutoCompleteHRESULT(iPtr,Win32.SHAutoCompleteFlags.SHACF_DEFAULT)

        Console.WriteLine("HRESULT handled: " + HRESULT.ToString())

    End Sub
End Module

Uwagi

PreserveSig Ustaw pole tak, aby true tłumaczyło niezarządzane podpisy bezpośrednio z wartościamiHRESULT. Ustaw je na false wartość , aby automatycznie konwertować HRESULT zwracane wartości na wyjątki. Domyślnie PreserveSig pole to true.

Gdy truesygnatura metody zarządzanej zwraca wartość całkowitą zawierającą HRESULT wartość . W takim przypadku należy ręcznie sprawdzić wartość zwracaną i odpowiednio odpowiedzieć w aplikacji.

Po ustawieniu PreserveSig pola na falsewartość , sygnatura metody zarządzanej ma typ zwracany void lub typ ostatniego niezarządzanego parametru [out, retval]. Gdy metoda niezarządzana generuje metodę HRESULT, środowisko uruchomieniowe automatycznie ignoruje wartość S_OK zwracaną (lub 0) i nie zgłasza wyjątku. W przypadku HRESULTparametrów innych niż S_OKśrodowisko uruchomieniowe automatycznie zgłasza wyjątek odpowiadający HRESULT.

Możesz zdecydować się na zmianę domyślnego zachowania raportowania błędów z HRESULTs na wyjątki w przypadkach, gdy wyjątki lepiej pasują do struktury raportowania błędów aplikacji.

To pole jest podobne do PreserveSigAttributewartości ; jednak w przeciwieństwie do PreserveSig pola wartość domyślna atrybutu to false.

W niektórych przypadkach deweloperzy języka Visual Basic używają instrukcji DllImportAttribute, a nie instrukcji Declare , aby zdefiniować funkcję DLL w kodzie zarządzanym. PreserveSig Ustawienie pola jest jednym z tych przypadków.

Zobacz też

• PreserveSigAttribute