OutAttribute Class

Definition

Указывает, что данные необходимо маршалировать из вызываемого объекта обратно в вызывающий объект.Indicates that data should be marshaled from callee back to caller.

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
type OutAttribute = class
    inherit Attribute
Public NotInheritable Class OutAttribute
Inherits Attribute
Inheritance
OutAttribute
Attributes

Examples

В следующем примере показано, как применить InAttribute и OutAttribute к прототипу вызова неуправляемого кода, который передает массив в качестве параметра.The following example shows how to apply the InAttribute and OutAttribute to a platform invoke prototype that passes an array as a parameter. Сочетание атрибутов направления позволяет вызывающему объекту видеть изменения, внесенные вызываемым объектом.The combination of directional attributes allows the caller to see the changes made by the callee.

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

Remarks

Этот атрибут можно применить к параметрам.You can apply this attribute to parameters.

OutAttribute является необязательным.The OutAttribute is optional. Атрибут поддерживается только для COM-взаимодействия и вызова неуправляемого кода.The attribute is supported for COM interop and platform invoke only. При отсутствии явных параметров упаковщик взаимодействия принимает правила на основе типа параметра, независимо от того, передается ли параметр по ссылке или по значению, а также является ли тип преобразуемым или непреобразуемым.In the absence of explicit settings, the interop marshaler assumes rules based on the parameter type, whether the parameter is passed by reference or by value, and whether the type is blittable or non-blittable. Например, для класса StringBuilder всегда предполагается, что он должен быть включен/out, а массив строк, переданных по значению, считается в.For example, the StringBuilder class is always assumed to be In/Out and an array of strings passed by value is assumed to be In.

Поведение "только исходящие" никогда не является поведением маршалинга по умолчанию для параметров.Out-only behavior is never a default marshaling behavior for parameters. Можно применить OutAttribute к ссылочным типам, передаваемым по ссылке, чтобы изменить поведение в режиме «только исходящие», что эквивалентно использованию ключевого слова out в C#.You can apply the OutAttribute to value and reference types passed by reference to change In/Out behavior to Out-only behavior, which is equivalent to using the out keyword in C#. Например, массивы, передаваемые по значению, маршалируются как параметры, используемые по умолчанию, могут быть изменены только на out.For example, arrays passed by value, marshaled as In-only parameters by default, can be changed to Out-only. Однако поведение не всегда предоставляет ожидаемую семантику, если типы содержат все преобразуемые элементы или поля, поскольку маршалером взаимодействия использует закрепление.However, the behavior does not always provide expected semantics when the types include all-blittable elements or fields because the interop marshaler uses pinning. Если вы не следите за передачей данных в вызываемый объект, маршалирование только исходящего качества может обеспечить лучшую производительность для преобразуемых типов.If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

Объединение InAttribute и OutAttribute особенно полезно при применении к массивам и форматированным, преобразуемым типам.Combining the InAttribute and OutAttribute is particularly useful when applied to arrays and formatted, non-blittable types. Вызывающие объекты видят изменения, которые вызываемый объект делает с этими типами только при применении обоих атрибутов.Callers see the changes a callee makes to these types only when you apply both attributes. Так как для этих типов требуется копирование во время маршалирования, можно использовать InAttribute и OutAttribute, чтобы уменьшить количество ненужных копий.Since these types require copying during marshaling, you can use InAttribute and OutAttribute to reduce unnecessary copies.

Дополнительные сведения о действиях OutAttribute при маршалинге см. в разделе атрибуты направления.For more information on the effect of OutAttribute on marshaling behavior, see Directional Attributes.

Constructors

OutAttribute()

Инициализирует новый экземпляр класса OutAttribute.Initializes a new instance of the OutAttribute class.

Properties

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also