OutAttribute OutAttribute OutAttribute OutAttribute Class

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

Ejemplos

El ejemplo siguiente muestra cómo aplicar el InAttribute y OutAttribute a una plataforma de prototipo que se pasa una matriz como parámetro de invocación.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;
   // ...
};

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

Comentarios

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

El OutAttribute es opcional.The OutAttribute is optional. El atributo es compatible con la interoperabilidad COM y solo la invocación de plataforma.The attribute is supported for COM interop and platform invoke only. En ausencia de una configuración explícita, el serializador de interoperabilidad supone que las reglas basan en el parámetro de tipo, si el parámetro se pasa por referencia o por valor y si el tipo es bits/bytes o espacio.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, el StringBuilder clase siempre se considera como In/Out y una matriz de cadenas que se pasan por valor 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.

Comportamiento solo hacia fuera nunca es el valor predeterminado es el cálculo de referencias para los parámetros.Out-only behavior is never a default marshaling behavior for parameters. Puede aplicar el OutAttribute a tipos de referencia y valor pasados por referencia para cambiar In/Out comportamiento al comportamiento solo hacia fuera, que es equivalente a usar el out palabra clave en C#.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, se pueden cambiar las matrices que se pasan por valor, se calculan las referencias como parámetros solo en de forma predeterminada, solo hacia fuera.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 elementos all-bits/bytes o porque el serializador de interoperabilidad utiliza la asignación de campos.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 desea saber acerca de cómo pasar datos en el destinatario, solo hacia fuera el cálculo de referencias puede proporcionar un mejor rendimiento para los tipos del espacio.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

Combinar el InAttribute y OutAttribute es especialmente útil cuando se aplica a las matrices y con formato, los tipos del espacio.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. Los llamadores verán los cambios que realiza un destinatario a estos tipos sólo cuando se aplican ambos atributos.Callers see the changes a callee makes to these types only when you apply both attributes. Puesto que estos tipos requieren copiar durante la serialización, puede usar InAttribute y OutAttribute para reducir el número de copias innecesaria.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 de OutAttribute en el comportamiento de serialización, vea atributos direccionales.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Constructores

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

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

Métodos

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

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

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

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

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

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

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

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

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

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

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

(Inherited from Object)

Implementaciones de interfaz explícitas

_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)

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.

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

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

(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)

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

(Inherited from Attribute)

Propiedades

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

(Inherited from Attribute)

Se aplica a

Consulte también: