OutAttribute Classe

Definizione

Indica che è necessario eseguire il marshalling dei dati dal destinatario della chiamata al chiamante.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
Ereditarietà
OutAttribute
Attributi

Esempi

Nell'esempio seguente viene illustrato come applicare InAttribute e OutAttribute a un prototipo Platform Invoke che passa una matrice come parametro.The following example shows how to apply the InAttribute and OutAttribute to a platform invoke prototype that passes an array as a parameter. La combinazione di attributi direzionali consente al chiamante di visualizzare le modifiche apportate dal chiamato.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

Commenti

È possibile applicare questo attributo ai parametri.You can apply this attribute to parameters.

OutAttribute È facoltativo.The OutAttribute is optional. L'attributo è supportato solo per l'interoperabilità COM e per platform invoke.The attribute is supported for COM interop and platform invoke only. In assenza di impostazioni esplicite, il gestore di marshalling di interoperabilità presuppone regole basate sul tipo di parametro, se il parametro viene passato per riferimento o per valore e se il tipo è copiabile o non copiabile.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. Ad esempio, si StringBuilder presuppone che la classe sia sempre in/out e che sia presente una matrice di stringhe passate per valore.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.

Il comportamento di sola uscita non è mai un comportamento di marshalling predefinito per i parametri.Out-only behavior is never a default marshaling behavior for parameters. È possibile applicare il OutAttribute valore a e i tipi di riferimento passati per riferimento per modificare il comportamento in/out del comportamento di sola uscita, che equivale a out usare la C#parola chiave in.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#. Per impostazione predefinita, ad esempio, le matrici passate per valore, sottoposte a marshalling come parametri solo in-only, possono essere modificate in solo out-only.For example, arrays passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Tuttavia, il comportamento non fornisce sempre la semantica prevista quando i tipi includono tutti gli elementi o i campi copiabili da, perché il gestore di marshalling di interoperabilità utilizza il blocco.However, the behavior does not always provide expected semantics when the types include all-blittable elements or fields because the interop marshaler uses pinning. Se non si è interessati al passaggio dei dati nel computer chiamato, il marshalling solo in uscita può offrire prestazioni migliori per i tipi non copiabili da copia di bit.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

InAttribute Combinare ed OutAttribute è particolarmente utile quando applicato alle matrici e ai tipi formattati e non copiabili.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. I chiamanti visualizzano le modifiche apportate da un chiamato a questi tipi solo quando si applicano entrambi gli attributi.Callers see the changes a callee makes to these types only when you apply both attributes. Poiché questi tipi richiedono la copia durante il marshalling, è InAttribute possibile OutAttribute usare e per ridurre le copie non necessarie.Since these types require copying during marshaling, you can use InAttribute and OutAttribute to reduce unnecessary copies.

Per ulteriori informazioni sull'effetto di sul OutAttribute comportamento del marshalling, vedere attributi direzionali.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Costruttori

OutAttribute()

Inizializza una nuova istanza della classe OutAttribute.Initializes a new instance of the OutAttribute class.

Proprietà

TypeId

Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Ereditato da Attribute)

Metodi

Equals(Object)

Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato.Returns a value that indicates whether this instance is equal to a specified object.

(Ereditato da Attribute)
GetHashCode()

Restituisce il codice hash per l'istanza.Returns the hash code for this instance.

(Ereditato da Attribute)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Ereditato da Object)
IsDefaultAttribute()

In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Ereditato da Attribute)
Match(Object)

Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Ereditato da Attribute)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Ereditato da Object)
ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Ereditato da Object)

Implementazioni dell'interfaccia esplicita

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

Esegue il mapping di un set di nomi a un set corrispondente di ID dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Ereditato da Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera le informazioni sul tipo relative a un oggetto, che possono essere usate per ottenere informazioni sul tipo relative a un'interfaccia.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Ereditato da Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera il numero delle interfacce di informazioni sul tipo fornite da un oggetto (0 o 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Ereditato da Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornisce l'accesso a proprietà e metodi esposti da un oggetto.Provides access to properties and methods exposed by an object.

(Ereditato da Attribute)

Si applica a

Vedi anche