OutAttribute クラス


呼び出し先から呼び出し元へ、データをマーシャリングすることを示します。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
type OutAttribute = class
    inherit Attribute
Public NotInheritable Class OutAttribute
Inherits Attribute

次の例は、配列をパラメーターとして渡すプラットフォーム呼び出しプロトタイプに 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
    int structSize;
    String^ filter;
    String^ file;
    // ...

private ref class NativeMethods

    // 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


この属性は、パラメーターに適用できます。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 クラスは常に In/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 のみの動作は、パラメーターの既定のマーシャリング動作ではありません。Out-only behavior is never a default marshaling behavior for parameters. 参照によって渡される値および参照型に OutAttribute を適用すると、の out キーワードを使用するのと同じように、入出力動作を Out only 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.



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



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

(継承元 Attribute)



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

(継承元 Attribute)

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

(継承元 Attribute)

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

(継承元 Object)

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)

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

(継承元 Attribute)

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

(継承元 Object)

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

(継承元 Object)


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

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 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.

(継承元 Attribute)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

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

(継承元 Attribute)