OutAttribute OutAttribute OutAttribute 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)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class OutAttribute : Attribute
type OutAttribute = class
    inherit Attribute
Public NotInheritable Class OutAttribute
Inherits Attribute
Inheritance
OutAttributeOutAttributeOutAttributeOutAttribute
Attributes

Examples

次の例では、適用する方法を示しています、InAttributeOutAttributeプラットフォーム呼び出しのプロトタイプをパラメーターとして配列を渡します。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;
   // ...
};

public ref class LibWrap
{
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;
    // ...
}

public class LibWrap
{
    // Declare a managed prototype for the unmanaged function.
    [DllImport("Comdlg32.dll", CharSet = CharSet.Unicode)]
    public 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 'OpenFileName

Public Class LibWrap
   ' Declare managed prototype for the unmanaged function.
   Declare Unicode Function GetOpenFileName Lib "Comdlg32.dll" ( _
      <[In](), Out()> ByVal ofn As OpenFileName) As Boolean
End Class 'LibWrap

Public Class App
    Public Shared Sub Main()

    End Sub 'Main
End Class 'App

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. 明示的な設定がない場合は、相互運用マーシャラーは、ルールは、型、パラメーターが渡される参照渡しまたは値渡しかどうかと、型は、blittable または blittable でないかどうか、パラメーターに基づくものとします。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クラスが入力/出力を常と見なされ、値によって渡された文字列の配列にあると想定します。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. ただし、動作は提供されない必要なセマンティクス、種類がすべて blittable 型の要素が含まれる場合や、相互運用マーシャラーは、ピン留めを使用するためのフィールドします。However, the behavior does not always provide expected semantics when the types include all-blittable elements or fields because the interop marshaler uses pinning. 呼び出し先にデータを渡すことはしない場合は、アウトのみがマーシャ リングと非 blittable 型のパフォーマンス向上を提供できます。If you do not care about passing data into the callee, Out-only marshaling can provide better performance for non-blittable types.

結合、InAttributeOutAttributeは場合に特に便利ですが配列に適用され、非 blittable 型を書式設定します。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. これらの型では、マーシャ リング中にコピーする必要があるために、使用できますInAttributeOutAttribute不要なコピーを削減します。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() OutAttribute() OutAttribute()

OutAttribute クラスの新しいインスタンスを初期化します。 Initializes a new instance of the OutAttribute class.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。 Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

このインスタンスのハッシュ コードを返します。 Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。 Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) Match(Object) Match(Object) Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。 Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。 Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。 Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Properties

TypeId TypeId TypeId TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。 When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Applies to

See Also