OutAttribute Klasse

Definition

Gibt an, dass Daten vom Aufgerufenen zurück an den Aufrufer gemarshallt werden.Indicates that data should be marshaled from callee back to caller.

public ref class OutAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class OutAttribute : Attribute
type OutAttribute = class
    inherit Attribute
Public NotInheritable Class OutAttribute
Inherits Attribute
Vererbung
OutAttribute
Attribute

Beispiele

Im folgenden Beispiel wird gezeigt, wie Sie InAttribute und OutAttribute auf einen Platt Form Aufruf-Prototyp anwenden, der ein Array als Parameter übergibt.The following example shows how to apply the InAttribute and OutAttribute to a platform invoke prototype that passes an array as a parameter. Die Kombination aus direktionalen Attributen ermöglicht dem Aufrufer, die vom aufgerufenen vorgenommenen Änderungen anzuzeigen.The combination of directional attributes allows the caller to see the changes made by the callee.

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.You can apply this attribute to parameters.

OutAttribute Ist optional.The OutAttribute is optional. Das-Attribut wird nur für COM-Interop und Platt Form Aufrufe unterstützt.The attribute is supported for COM interop and platform invoke only. Wenn keine expliziten Einstellungen vorhanden sind, übernimmt der Interop-Mars Haller Regeln, die auf dem Parametertyp basieren, ob der Parameter als Verweis oder als Wert übergeben wird und ob der Typ blitfähig oder nicht blitfähig ist.In the absence of explicit settings, the interop marshaler assumes rules based on the parameter type, whether the parameter is passed by reference or by value, and whether the type is blittable or non-blittable. Beispielsweise wird angenommen StringBuilder , dass die-Klasse in/out ist, und ein Array von Zeichen folgen, die als Wert übergebenen werden, wird als in angenommen.For example, the StringBuilder class is always assumed to be In/Out and an array of strings passed by value is assumed to be In.

Das reine Verhalten ist nie ein Standardmäßiges Marshallingverhalten für Parameter.Out-only behavior is never a default marshaling behavior for parameters. Sie können den auf OutAttribute Wert und Verweis Typen, die als Verweis übergebenen werden, anwenden, um das Verhalten in nur-Out-Verhalten zu ändern, out was der C#Verwendung des-Schlüssel Worts in entspricht.You can apply the OutAttribute to value and reference types passed by reference to change In/Out behavior to Out-only behavior, which is equivalent to using the out keyword in C#. Beispielsweise können als Wert übergebene Arrays, die standardmäßig als in-only-Parameter gemarshallt werden, in out-only geändert werden.For example, arrays passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Allerdings bietet das Verhalten nicht immer die erwartete Semantik, wenn die Typen alle blitfähigen Elemente oder Felder einschließen, da der Interop-Mars Haller Pinning verwendet.However, the behavior does not always provide expected semantics when the types include all-blittable elements or fields because the interop marshaler uses pinning. Wenn Sie sich keine Gedanken über das Übergeben von Daten an den aufgerufenen machen, kann das out-only-Marshalling eine bessere Leistung für nicht blitfähige Typen bieten.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

Die InAttribute Kombination OutAttribute von und ist besonders nützlich, wenn Sie auf Arrays und formatierte, nicht blitfähige Typen angewendet wird.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. Aufrufer sehen die Änderungen, die ein aufgerufener an diesen Typen vornimmt, wenn Sie beide Attribute anwenden.Callers see the changes a callee makes to these types only when you apply both attributes. Da diese Typen beim Marshalling kopiert werden müssen, können Sie und InAttribute OutAttribute verwenden, um unnötige Kopien zu verringern.Since these types require copying during marshaling, you can use InAttribute and OutAttribute to reduce unnecessary copies.

Weitere Informationen zu den Auswirkungen des OutAttribute marshallingverhaltens finden Sie unter direktionale Attribute.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Konstruktoren

OutAttribute()

Initialisiert eine neue Instanz der OutAttribute-Klasse.Initializes a new instance of the OutAttribute class.

Eigenschaften

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für:

Siehe auch