OutAttribute Classe

Definizione

Spazio dei nomi:

System.Runtime.InteropServices

Assembly:

netstandard.dll, System.Runtime.dll

Origine:

OutAttribute.cs

Indica che il marshalling dei dati deve essere eseguito dal chiamato al chiamante.

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)>]
type OutAttribute = class
    inherit Attribute

Public NotInheritable Class OutAttribute
Inherits Attribute

Ereditarietà

Object

Attribute

OutAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio seguente viene illustrato come applicare InAttribute e OutAttribute a un prototipo platform invoke che passa una matrice come parametro. La combinazione di attributi direzionali consente al chiamante di visualizzare le modifiche apportate dal chiamato.

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

Commenti

È possibile applicare questo attributo ai parametri.

è OutAttribute facoltativo. L'attributo è supportato solo per l'interoperabilità COM e platform invoke. In assenza di impostazioni esplicite, il gestore di marshalling di interoperabilità presuppone regole in base al tipo di parametro, indipendentemente dal fatto che il parametro venga passato per riferimento o per valore e se il tipo sia copiabile da blttable o non blttable. Ad esempio, si presuppone che la StringBuilder classe sia sempre In/Out e si presuppone che una matrice di stringhe passate per valore sia In.

Il comportamento out-only non è mai un comportamento di marshalling predefinito per i parametri. È possibile applicare a valori OutAttribute e tipi di riferimento passati per riferimento per modificare il comportamento In/Out in modo che sia equivalente all'uso della out parola chiave in C#. Ad esempio, le matrici passate per valore, con marshalling come parametri solo in modalità predefinita, possono essere modificate in Out-only. Tuttavia, il comportamento non fornisce sempre la semantica prevista quando i tipi includono elementi o campi tutti blttable perché il gestore di marshalling di interoperabilità usa l'aggiunta. Se non ci si preoccupa di passare i dati nel chiamato, il marshalling out-only può offrire prestazioni migliori per i tipi non copiabili.

La combinazione di InAttribute e OutAttribute è particolarmente utile quando viene applicata a matrici e tipi formattati e non copiabili da blt. I chiamanti visualizzano le modifiche apportate da un chiamato a questi tipi solo quando si applicano entrambi gli attributi. Poiché questi tipi richiedono la copia durante il marshalling, è possibile usare InAttribute e OutAttribute ridurre le copie non necessarie.

Costruttori

Nome	Descrizione
OutAttribute()	Inizializza una nuova istanza della classe OutAttribute.

Proprietà

Nome	Descrizione
TypeId	Se implementato in una classe derivata, ottiene un identificatore univoco per questo Attribute. (Ereditato da Attribute)

Metodi

Nome	Descrizione
Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per questa istanza. (Ereditato da Attribute)
GetType()	Ottiene il Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	Quando sottoposto a override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale del Objectcorrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)

Vedi anche

• InAttribute
• StringBuilder
• Blittable and Non-Blittable Types (Tipi copiabili da BLT e non copiabili da BLT)