OutAttribute Klasa

Definicja

Przestrzeń nazw:

System.Runtime.InteropServices

Zestaw:

System.Runtime.dll

Źródło:

OutAttribute.cs

Wskazuje, że dane powinny być marshaled z wywoływanego z powrotem do obiektu wywołującego.

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)>]
type OutAttribute = class
    inherit Attribute

Public NotInheritable Class OutAttribute
Inherits Attribute

Dziedziczenie

Object

Attribute

OutAttribute

Atrybuty

AttributeUsageAttribute

Przykłady

W poniższym przykładzie pokazano, jak zastosować InAttribute element i OutAttribute do platformy wywołać prototyp, który przekazuje tablicę jako parametr. Kombinacja atrybutów kierunkowych umożliwia wywołującym wyświetlanie zmian wprowadzonych przez obiekt wywoływany.

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

Uwagi

Ten atrybut można zastosować do parametrów.

Element OutAttribute jest opcjonalny. Atrybut jest obsługiwany tylko w przypadku międzyoperacyjnego modelu COM i wywoływania platformy. W przypadku braku jawnych ustawień marshaler międzyoperacyjny zakłada reguły oparte na typie parametru, czy parametr jest przekazywany przez odwołanie, czy przez wartość, oraz czy typ jest nielitowalny, czy nielitowalny. Na przykład przyjmuje się, że klasa jest zawsze włączona/wychodząca, a przyjmuje się, StringBuilder że tablica ciągów przekazywanych przez wartość ma wartość W.

Zachowanie tylko poza wartością nigdy nie jest domyślnym zachowaniem marshalingu dla parametrów. Można zastosować metodę OutAttribute do typów wartości i odwołań przekazywanych przez odwołanie, aby zmienić zachowanie typu In/Out na zachowanie tylko poza wartością, co jest równoważne użyciu słowa kluczowego out w języku C#. Na przykład tablice przekazywane przez wartość, marshaled jako parametry tylko domyślnie, można zmienić na tylko na out-only. Jednak zachowanie nie zawsze zapewnia oczekiwaną semantyka, gdy typy zawierają wszystkie elementy lub pola, ponieważ marshaler międzyoperator używa przypinania. Jeśli nie dbasz o przekazywanie danych do obiektu wywoływanego, przeprowadzanie marshalingu tylko na out-only może zapewnić lepszą wydajność dla typów nielitowalnych.

Łączenie elementów InAttribute i OutAttribute jest szczególnie przydatne w przypadku zastosowania do tablic i sformatowanych, nielitowalnych typów. Wywołujący widzą zmiany wprowadzane przez obiekt wywoływany do tych typów tylko po zastosowaniu obu atrybutów. Ponieważ te typy wymagają kopiowania podczas marshalingu, można użyć polecenia InAttribute i OutAttribute zmniejszyć liczbę niepotrzebnych kopii.

Aby uzyskać więcej informacji na temat wpływu działania marshalingu OutAttribute , zobacz Atrybuty kierunkowe.

Konstruktory

OutAttribute()

Inicjuje nowe wystąpienie klasy OutAttribute.

Właściwości

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu . (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Podczas zastępowania w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną dla klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• InAttribute
• StringBuilder
• Typy kopiowalne i niekopiowalne