OutAttribute Klasse

Definition

public ref class OutAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
public sealed class OutAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class OutAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
type OutAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type OutAttribute = class
    inherit Attribute

Public NotInheritable Class OutAttribute
Inherits Attribute

Vererbung

Object

Attribute

OutAttribute

Attribute

AttributeUsageAttribute ComVisibleAttribute

Beispiele

Das folgende Beispiel zeigt, wie Sie den Prototyp OutAttribute einer InAttribute Plattform anwenden, die ein Array als Parameter übergibt. Die Kombination von direktionalen Attributen ermöglicht es dem Aufrufer, die vom Angerufenen vorgenommenen Änderungen anzuzeigen.

using namespace System;
using namespace System::Runtime::InteropServices;

// Declare a class member for each structure element.

[StructLayout(LayoutKind::Sequential, CharSet = CharSet::Unicode)]
public ref class OpenFileName
{
public:
    int structSize;
    String^ filter;
    String^ file;
    // ...
};

private ref class NativeMethods
{
public:

    // Declare a managed prototype for the unmanaged function.

    [DllImport("Comdlg32.dll", CharSet = CharSet::Unicode)]
    static bool GetOpenFileName([In, Out]OpenFileName^ ofn);
};

void main() {}

using System.Runtime.InteropServices;
using System;

// Declare a class member for each structure element.
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public class OpenFileName
{
    public int structSize = 0;
    public string filter = null;
    public string file = null;
    // ...
}

internal static class NativeMethods
{
    // Declare a managed prototype for the unmanaged function.
    [DllImport("Comdlg32.dll", CharSet = CharSet.Unicode)]
    internal static extern bool GetOpenFileName([In, Out] OpenFileName ofn);
}

public class MainMethod
{
    static void Main()
    { }
}

Imports System.Runtime.InteropServices

' Declare a class member for each structure element.
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Class OpenFileName

    Public structSize As Integer = 0
    Public filter As String = Nothing
    Public file As String = Nothing
    ' ...

End Class

Friend Class NativeMethods
    ' Declare managed prototype for the unmanaged function.
    Friend Declare Unicode Function GetOpenFileName Lib "Comdlg32.dll" (
       <[In](), Out()> ByVal ofn As OpenFileName) As Boolean
End Class

Public Class App
    Public Shared Sub Main()

    End Sub
End Class

Hinweise

Sie können dieses Attribut auf Parameter anwenden.

Dies OutAttribute ist optional. Das Attribut wird nur für COM-Interoperabilität und Plattform-Aufruf unterstützt. Wenn keine expliziten Einstellungen vorhanden sind, geht der Interop marshaler von Regeln basierend auf dem Parametertyp aus, unabhängig davon, ob der Parameter durch Verweis oder Wert übergeben wird und ob der Typ blittbar oder nicht blittbar ist. Die Klasse wird z. B. immer als In/Out angenommen, und es wird angenommen, StringBuilder dass ein Array von Zeichenfolgen, die durch den Wert übergeben werden, in.

Das ausschließliche Verhalten ist niemals ein Standardmäßiges Marshaling-Verhalten für Parameter. Sie können die Wert- und Verweistypen anwenden, die OutAttribute durch Verweis übergeben werden, um das In/Out-Verhalten auf das "Out-only"-Verhalten zu ändern. Dies entspricht der Verwendung des out Schlüsselworts in C#. Arrays, die standardmäßig als Nur-Parameter gemarstet werden, können beispielsweise standardmäßig in "Out-only" geändert werden.For example, passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Das Verhalten stellt jedoch nicht immer erwartete Semantik bereit, wenn die Typen all-blittable Elemente oder Felder enthalten, da der Interop marshaler pinning verwendet. Wenn Sie sich nicht darum kümmern, Daten an den Angerufenen zu übergeben, kann out-only Marshaling eine bessere Leistung für nicht zerkleinerbare Typen bieten.

Das Kombinieren der InAttribute Matrix und OutAttribute ist besonders nützlich, wenn sie auf Arrays und formatierte, nicht unterschreibbare Typen angewendet wird. Anrufer sehen die Änderungen, die ein Angerufener an diesen Typen vornimmt, nur, wenn Sie beide Attribute anwenden. Da diese Typen während des Marshallings kopieren müssen, können Sie unnötige Kopien verwenden InAttribute und OutAttribute reduzieren.

Weitere Informationen

• InAttribute
• StringBuilder
• Blitfähige und nicht blitfähige Typen