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

Im folgenden Beispiel wird gezeigt, wie sie und InAttributeOutAttribute auf einen Plattformaufrufprototyp anwenden, der ein Array als Parameter übergibt. Die Kombination von Richtungsattributen ermöglicht es dem Aufrufer, die vom Angerufenen vorgenommenen Änderungen zu sehen.

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.

Der OutAttribute ist optional. Das Attribut wird nur für COM-Interop und Plattformaufrufe unterstützt. Wenn keine expliziten Einstellungen vorhanden sind, übernimmt der Interop-Marshaller Regeln basierend auf dem Parametertyp, ob der Parameter als Verweis oder Wert übergeben wird und ob der Typ blittbar oder nicht blittbar ist. Beispielsweise wird immer davon ausgegangen, dass die StringBuilder Klasse In/Out ist, und ein Array von Zeichenfolgen, die vom Wert übergeben werden, wird als In angenommen.

Out-Only-Verhalten ist nie ein Standardmäßiges Marshallverhalten für Parameter. Sie können die auf Wert- und Verweistypen anwenden, die OutAttribute als Verweis übergeben werden, um das In/Out-Verhalten auf das Out-Only-Verhalten zu ändern, was der Verwendung des out Schlüsselwort (keyword) in C# entspricht. Beispielsweise können Arrays, die als Wert übergeben werden und standardmäßig als in-only-Parameter gemarst werden, in Out-only geändert werden. Das Verhalten stellt jedoch nicht immer erwartete Semantik bereit, wenn die Typen alle blittbaren Elemente oder Felder enthalten, da der Interop-Marshaller das Anheften verwendet. Wenn Sie sich nicht darum kümmern, Daten an den Angerufenen zu übergeben, kann das Out-Only-Marshalling eine bessere Leistung für nicht zerteilbare Typen bieten.

Die Kombination von InAttribute und OutAttribute ist besonders nützlich, wenn sie auf Arrays und formatierte, nicht kleinteilige 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 Marshallvorgangs kopieren müssen, können Sie und OutAttribute verwendenInAttribute, um unnötige Kopien zu reduzieren.

Weitere Informationen zur Auswirkung von OutAttribute auf das Marshallverhalten finden Sie unter Richtungsattribute.

Konstruktoren

Eigenschaften

Methoden

Explizite Schnittstellenimplementierungen

Gilt für:

Weitere Informationen

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