OutAttribute Класс

Определение

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

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

Object

Attribute

OutAttribute

Атрибуты

AttributeUsageAttribute ComVisibleAttribute

Примеры

В следующем примере показано, как применить 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 или non-blittable. Например, StringBuilder класс всегда предполагается как In/Out, а массив строк, передаваемых по значению, — как In.

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

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

Дополнительные сведения о влиянии OutAttribute на поведение маршалинга см. в разделе Атрибуты направления.

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

Свойства

Методы

Явные реализации интерфейса

Применяется к

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

• InAttribute
• StringBuilder
• Преобразуемые и непреобразуемые типы