OutAttribute Třída

Definice

Obor názvů:

System.Runtime.InteropServices

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

OutAttribute.cs

Označuje, že data by měla být zařazována z volaného zpět volajícímu.

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

Dědičnost

Object

Attribute

OutAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad ukazuje, jak použít InAttribute prototyp vyvolání platformy, OutAttribute který předává pole jako parametr. Kombinace směrových atributů umožňuje volajícímu zobrazit změny provedené volanou.

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

Poznámky

Tento atribut můžete použít na parametry.

Je OutAttribute nepovinný. Atribut je podporován pouze pro volání zprostředkovatele komunikace com a platformy. Bez explicitního nastavení předpokládá zprostředkovatele komunikace pravidla založená na typu parametru, zda je parametr předán odkazem nebo hodnotou a zda je typ blittable nebo non-blittable. Například StringBuilder třída je vždy považována za In/Out a pole řetězců předaných hodnotou je považováno za In.

Chování pouze pro out-only není výchozím chováním zařazování parametrů. Můžete použít OutAttribute na hodnoty a odkazové typy předané odkazem, aby se změnilo chování typu In/Out na out-only chování, což je ekvivalentní použití klíčového out slova v jazyce C#. Například pole předaná hodnotou, která jsou ve výchozím nastavení zařazena jako parametry pouze v rámci, je možné změnit na out-only. Chování však neposkytuje vždy očekávanou sémantiku, pokud typy obsahují všechny prvky nebo pole, protože zprostředkovatele komunikace používá připnutí. Pokud vás nezajímá předávání dat do volaného, zařazování pouze mimo něj může poskytovat lepší výkon pro nešilitelné typy.

Kombinování InAttribute a OutAttribute je zvlášť užitečné při použití u polí a formátovaných, nelimitovatelných typů. Volající uvidí změny, které volaný u těchto typů provede, pouze když použijete oba atributy. Vzhledem k tomu, že tyto typy vyžadují kopírování během zařazování, můžete použít InAttribute a OutAttribute snížit nepotřebné kopie.

Konstruktory

Name	Description
OutAttribute()	Inicializuje novou instanci OutAttribute třídy.

Vlastnosti

Name	Description
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)

Viz také

• InAttribute
• StringBuilder
• Blittovací a neblittovací typy