OutAttribute OutAttribute OutAttribute OutAttribute Class

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
OutAttributeOutAttributeOutAttributeOutAttribute
Attribute

Beispiele

Das folgende Beispiel zeigt, wie Sie anwenden der InAttribute und OutAttribute auf einer Plattform aufrufen Prototyp, der ein Array als Parameter übergeben wird.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 von direktionalen Attribute ermöglicht den Aufrufer, die durch den 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;
   // ...
};

public ref class LibWrap
{
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;
    // ...
}

public class LibWrap
{
    // Declare a managed prototype for the unmanaged function.
    [DllImport("Comdlg32.dll", CharSet = CharSet.Unicode)]
    public 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 'OpenFileName

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

Public Class App
    Public Shared Sub Main()

    End Sub 'Main
End Class 'App

Hinweise

Sie können dieses Attribut auf Parameter anwenden.You can apply this attribute to parameters.

Die OutAttribute ist optional.The OutAttribute is optional. Das Attribut wird für COM-Interop unterstützt, und der Plattformaufruf nur.The attribute is supported for COM interop and platform invoke only. In expliziten Einstellungen fehlen vorausgesetzt der interop-Marshaller Regeln basiert auf dem Parameter, Typ, gibt an, ob der Parameter als Verweis oder als Wert übergeben wird und gibt an, ob der Typ für Blitvorgänge geeignet oder nicht für Blitvorgänge 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. Z. B. die StringBuilder Klasse wird immer als In/Out und ein Array von Zeichenfolgen, die als Wert übergeben, wird davon ausgegangen, dass in.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.

Nur Out-Verhalten ist nie eine standardmäßige Marshallingverhalten für Parameter.Out-only behavior is never a default marshaling behavior for parameters. Sie anwenden können die OutAttribute zu Wert- und Referenztypen, übergeben als Verweis In/Out-Verhalten in nur-Out-Verhalten zu ändern und dadurch die Verwendung entspricht der out Schlüsselwort in C# geschrieben.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 für Arrays, die nach Wert übergeben, als In-Parameter gemarshallt wird, werden standardmäßig zu außenumgrenzung geändert werden.For example, arrays passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Das Verhalten wird jedoch immer bietet keine erwarteten Semantik, wenn alle blitfähigen Elementen gehören oder Felder, da der interop-Marshaller Anheften von Zertifikaten 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 Daten an die aufgerufene Methode übergibt unerheblich ist, kann die außenumgrenzung Marshalling eine bessere Leistung für nicht blitfähige Typen bereitstellen.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

Kombinieren der InAttribute und OutAttribute ist besonders nützlich, wenn auf Arrays angewendet, und formatiert, nicht blitfähige Typen.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. Aufrufer sehen Änderungen, die die eine aufrufende Instanz für diese Art wird nur verwendet werden, wenn Sie beide Attribute anwenden.Callers see the changes a callee makes to these types only when you apply both attributes. Da diese Typen erforderlich ist, während des Marshalling kopieren, können Sie InAttribute und OutAttribute unnötige Kopien zu reduzieren.Since these types require copying during marshaling, you can use InAttribute and OutAttribute to reduce unnecessary copies.

Weitere Informationen zu den Auswirkungen der OutAttribute auf das Marshallingverhalten finden Sie unter direktionalen Attribute.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Konstruktoren

OutAttribute() OutAttribute() OutAttribute() OutAttribute()

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

Methoden

Equals(Object) Equals(Object) Equals(Object) 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.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) 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.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _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.

(Inherited from Attribute)

Eigenschaften

TypeId TypeId TypeId 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.

(Inherited from Attribute)

Gilt für:

Siehe auch