InAttribute Classe

Definição

public ref class InAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
public sealed class InAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class InAttribute : Attribute

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

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

Public NotInheritable Class InAttribute
Inherits Attribute

Herança

Object

Attribute

InAttribute

Atributos

AttributeUsageAttribute ComVisibleAttribute

Exemplos

O exemplo seguinte mostra como aplicar o InAttribute e OutAttribute a um protótipo de invocação de plataforma que passa um array como parâmetro. A combinação de atributos direcionais permite ao chamador ver as alterações feitas pelo chamado.

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

Observações

Pode aplicar este atributo a parâmetros.

É InAttribute opcional. O atributo é suportado apenas para interoperabilidade COM e invocação de plataforma. Na ausência de definições explícitas, o marshaler de interoperabilidade assume regras com base no tipo de parâmetro, se o parâmetro é passado por referência ou por valor, e se o tipo é blitável ou não. Por exemplo, assume-se sempre que a StringBuilder classe é In/Out e um array de cadeias passadas por valor é assumido como In.

Não pode aplicar o InAttribute a um parâmetro modificado com a palavra-chave ao estilo out C#. Para evitar confundir a palavra-chave In em Visual Basic com a InAttribute, menos Atributo, use o formulário <[In]> com parênteses à volta do atributo.

Combinar os InAttribute e OutAttribute é particularmente útil quando aplicado a arrays e tipos formatados, não blitáveis. Os chamadores só veem as alterações que um chamado faz a estes tipos quando aplicas ambos os atributos. Como estes tipos requerem cópia durante o marshaling, pode usar InAttribute e OutAttribute reduzir cópias desnecessárias.

Para mais informações sobre o efeito do InAttribute comportamento de marshaling, veja Atributos Direcionais.

Ver também

• OutAttribute
• StringBuilder
• Tipos Blittable e Non-Blittable