OutAttribute Clase

Definición

Indica que el cálculo de referencias de los datos debe realizarse del destinatario de la llamada al llamador.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
Herencia
OutAttribute
Atributos

Ejemplos

En el ejemplo siguiente se muestra cómo aplicar InAttribute y OutAttribute a un prototipo de invocación de plataforma que pasa una matriz como parámetro.The following example shows how to apply the InAttribute and OutAttribute to a platform invoke prototype that passes an array as a parameter. La combinación de atributos direccionales permite al llamador ver los cambios realizados por el destinatario.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

Comentarios

Este atributo se puede aplicar a parámetros.You can apply this attribute to parameters.

OutAttribute Es opcional.The OutAttribute is optional. El atributo solo es compatible con la interoperabilidad COM y la invocación de plataforma.The attribute is supported for COM interop and platform invoke only. En ausencia de valores explícitos, el contador de referencias de interoperabilidad asume reglas basadas en el tipo de parámetro, si el parámetro se pasa por referencia o por valor, y si el tipo es que se pueden retrasar o no bits por bytes.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. Por ejemplo, la StringBuilder clase siempre se supone que está dentro/fuera y se supone que una matriz de cadenas pasadas por valor está en.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.

El comportamiento de solo salida nunca es un comportamiento de cálculo de referencias predeterminado para los parámetros.Out-only behavior is never a default marshaling behavior for parameters. Puede aplicar a los OutAttribute tipos de valor y de referencia pasados por referencia para cambiar el comportamiento de in/out a un comportamiento de solo salida, que es out equivalente a C#usar la palabra clave en.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#. Por ejemplo, las matrices que se pasan por valor, serializadas como parámetros solo de forma predeterminada, se pueden cambiar a solo salida.For example, arrays passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Sin embargo, el comportamiento no siempre proporciona la semántica esperada cuando los tipos incluyen todos los elementos o campos que se pueden retrasar, ya que el serializador de interoperabilidad utiliza el anclaje.However, the behavior does not always provide expected semantics when the types include all-blittable elements or fields because the interop marshaler uses pinning. Si no le importa el paso de datos al destinatario, la serialización de solo salida puede proporcionar un mejor rendimiento para los tipos que no pueden transferirse en bytes.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

La combinación InAttribute de OutAttribute y es especialmente útil cuando se aplica a matrices y tipos con formato que no pueden representarse como bits/bytes.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. Los autores de las llamadas ven los cambios que un destinatario realiza en estos tipos solo cuando se aplican ambos atributos.Callers see the changes a callee makes to these types only when you apply both attributes. Dado que estos tipos requieren copia durante el cálculo de referencias, InAttribute puede OutAttribute usar y para reducir las copias innecesarias.Since these types require copying during marshaling, you can use InAttribute and OutAttribute to reduce unnecessary copies.

Para obtener más información sobre el efecto OutAttribute de en el cálculo de referencias, vea atributos direccionales.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Constructores

OutAttribute()

Inicializa una nueva instancia de la clase OutAttribute.Initializes a new instance of the OutAttribute class.

Propiedades

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)

Métodos

Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Heredado de Attribute)
GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Heredado de Attribute)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Heredado de Attribute)
Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a

Consulte también: