OutAttribute Classe

Definição

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)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class OutAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
type OutAttribute = class
    inherit Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type OutAttribute = class
    inherit Attribute

Public NotInheritable Class OutAttribute
Inherits Attribute

Herança

Object

Attribute

OutAttribute

Atributos

AttributeUsageAttribute ComVisibleAttribute

Exemplos

O exemplo a seguir mostra como aplicar o InAttribute e OutAttribute a um protótipo de invocação de plataforma que passa uma matriz como um parâmetro. A combinação de atributos direcionais permite que o chamador veja as alterações feitas pelo receptor.

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

Comentários

Você pode aplicar esse atributo a parâmetros.

O OutAttribute é opcional. O atributo tem suporte apenas para interoperabilidade COM e invocação de plataforma. Na ausência de configurações explícitas, o marshaler de interoperabilidade pressupõe regras com base no tipo de parâmetro, se o parâmetro é passado por referência ou por valor e se o tipo é blittable ou não blittable. Por exemplo, a StringBuilder classe sempre é considerada Entrada/Saída e uma matriz de cadeias de caracteres passadas por valor é considerada In.

O comportamento somente out-only nunca é um comportamento de marshaling padrão para parâmetros. Você pode aplicar o OutAttribute a tipos de valor e referência passados por referência para alterar o comportamento de Entrada/Saída para Comportamento somente saída, que é equivalente a usar a out palavra-chave em C#. Por exemplo, matrizes passadas por valor, empacotadas como parâmetros somente in por padrão, podem ser alteradas para Somente saída. No entanto, o comportamento nem sempre fornece semântica esperada quando os tipos incluem todos os elementos ou campos blittable porque o marshaler de interoperabilidade usa fixação. Se você não se importa em passar dados para o receptor, o marshaling somente out pode fornecer melhor desempenho para tipos não blittable.

Combinar o InAttribute e OutAttribute é particularmente útil quando aplicado a matrizes e tipos formatados e não blittable. Os chamadores veem as alterações feitas por um computador chamado a esses tipos somente quando você aplica ambos os atributos. Como esses tipos exigem cópia durante o marshaling, você pode usar InAttribute e OutAttribute reduzir cópias desnecessárias.

Para obter mais informações sobre o efeito do comportamento de OutAttribute marshaling, consulte Atributos direcionais.

Construtores

Propriedades

Métodos

Implantações explícitas de interface

Aplica-se a

Confira também

• InAttribute
• StringBuilder
• Tipos blittable e não blittable