OutAttribute Класс

Определение

Пространство имен:

System.Runtime.InteropServices

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

OutAttribute.cs

Указывает, что данные должны маршалироваться от вызываемого обратно вызывающего абонента.

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

Наследование

Object

Attribute

OutAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере показано, как применить InAttribute и OutAttribute к платформе вызов прототипа, который передает массив в качестве параметра. Сочетание атрибутов направления позволяет вызывающей стороне видеть изменения, внесенные вызывающим элементом.

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

Комментарии

Этот атрибут можно применить к параметрам.

Необязательный OutAttribute . Атрибут поддерживается только для com-взаимодействия и вызова платформы. В отсутствие явных параметров маршалер взаимодействия предполагает правила, основанные на типе параметра, передается ли параметр по ссылке или по значению, а также указывает, является ли тип blittable или недоступен. Например, класс всегда считается in/Out, и предполагается, StringBuilder что массив строк, передаваемых значением, считается In.

Поведение только для выхода никогда не является поведением маршалинга по умолчанию для параметров. Можно применить OutAttribute к типам значений и ссылок, передаваемым по ссылке, чтобы изменить поведение in/Out на поведение только для выхода, что эквивалентно использованию ключевого out слова в C#. Например, массивы, передаваемые по значению, маршалируются как параметры только для использования по умолчанию, могут быть изменены только на out-only. Однако поведение не всегда обеспечивает ожидаемую семантику, если типы включают все элементы или поля, так как маршалер взаимодействия использует закрепление. Если вы не заботитесь о передаче данных в вызываемую функцию, маршалинг только для выхода может обеспечить более высокую производительность для неустойчивых типов.

Объединение InAttribute и OutAttribute особенно полезно при применении к массивам и отформатированным типам, не допускающим перерезки. Вызывающие отображают изменения вызываемого объекта только при применении обоих атрибутов. Так как эти типы требуют копирования во время маршалинга, можно использовать InAttribute и OutAttribute уменьшить ненужные копии.

Конструкторы

Имя	Описание
OutAttribute()	Инициализирует новый экземпляр класса OutAttribute.

Свойства

Имя	Описание
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• InAttribute
• StringBuilder
• Блитабельные и неблитабельные типы