Clase OutAttribute

 

Publicado: octubre de 2016

Indica que las referencias de los datos se deben calcular desde el destinatario de la llamada al llamador.

Espacio de nombres:   System.Runtime.InteropServices
Ensamblado:  mscorlib (en mscorlib.dll)

Jerarquía de herencia

System.Object
  System.Attribute
    System.Runtime.InteropServices.OutAttribute

Sintaxis

[AttributeUsageAttribute(AttributeTargets.Parameter, Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class OutAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Parameter, Inherited = false)]
[ComVisibleAttribute(true)]
public ref class OutAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Parameter, Inherited = false)>]
[<ComVisibleAttribute(true)>]
type OutAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Parameter, Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class OutAttribute
    Inherits Attribute

Constructores

	Nombre	Descripción
	OutAttribute()	Inicializa una nueva instancia de la clase OutAttribute.

Propiedades

	Nombre	Descripción
	TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.(Heredado de Attribute).

Métodos

	Nombre	Descripción
	Equals(Object)	Esta API admite la infraestructura producto y no está diseñada para usarse directamente desde el código. Devuelve un valor que indica si esta instancia es igual que un objeto especificado.(Heredado de Attribute).
	GetHashCode()	Devuelve el código hash de esta instancia.(Heredado de Attribute).
	GetType()	Obtiene el Type de la instancia actual.(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.(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.(Heredado de Attribute).
	ToString()	Devuelve una cadena que representa el objeto actual.(Heredado de Object).

Implementaciones de interfaz explícitas

	Nombre	Descripción
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.(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.(Heredado de Attribute).
	_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 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.(Heredado de Attribute).

Comentarios

Este atributo se puede aplicar a parámetros.

El OutAttribute es opcional. El atributo se admite para interoperabilidad COM y solo la invocación de plataforma. En ausencia de valores explícitos, el contador de referencias de interoperabilidad supone reglas basan en el parámetro de tipo, si el parámetro se pasa por referencia o por valor y si el tipo es transferirse o espacio. Por ejemplo, el StringBuilder clase siempre se supone que la entrada/salida y se supone están en una matriz de cadenas que se pasan por valor.

Comportamiento solo nunca es un valor predeterminado el cálculo de referencias para los parámetros. Puede aplicar el OutAttribute tipos de valor y referencia pasados por referencia para cambiar la entrada/salida comportamiento al comportamiento de sólo Out, que equivale a usar la out palabra clave de C#. Por ejemplo, matrices que se pasan por valor, se calculan las referencias como parámetros sólo In de forma predeterminada, se pueden cambiar a sólo Out. Sin embargo, el comportamiento no siempre proporciona la semántica esperada cuando los tipos incluyen transferirse todos los elementos o campos porque el contador de referencias de interoperabilidad utiliza la fijación. Si no le importa pasar datos en el destinatario, el cálculo de referencias sólo Out puede proporcionar un mejor rendimiento para los tipos.

Combinar el InAttribute y OutAttribute es especialmente útil cuando se aplica a matrices y tipos, el formato. Los llamadores ven los cambios que realiza un destinatario de la llamada a estos tipos sólo cuando se aplican ambos atributos. Como estos tipos requieren copias durante el cálculo de referencias, se puede utilizar InAttribute y OutAttribute para reducir el número de copias innecesaria.

Para obtener más información sobre el efecto de OutAttribute en el cálculo de referencias, vea atributos direccionales.

Ejemplos

En el ejemplo siguiente se muestra cómo aplicar el InAttribute y OutAttribute prototipo que pasa una matriz como parámetro de invocación de una plataforma. La combinación de atributos direccionales permite al llamador ver los cambios realizados por el destinatario.

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

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

Información de versión

Plataforma universal de Windows
Disponible desde 8
.NET Framework
Disponible desde 1.1
Biblioteca de clases portable
Se admite en: plataformas portátiles de .NET
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Windows Phone
Disponible desde 8.1

Seguridad para subprocesos

Cualquier miembro ( Compartido en Visual Basic) estático público de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Ver también

InAttribute
StringBuilder
Espacio de nombres System.Runtime.InteropServices
Blittable and Non-Blittable Types

Volver al principio