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

示例

以下示例演示如何将 和 OutAttribute 应用于InAttribute将数组作为参数传递的平台调用原型。 方向属性的组合允许调用方查看被调用方所做的更改。

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 还是非 blittable 来假定规则。 例如， StringBuilder 类始终假定为 In/Out，并且值传递的字符串数组假定为 In。

Out-only 行为绝不是参数的默认封送处理行为。 可以将 应用于OutAttribute值和通过引用传递的引用类型，以将 In/Out 行为更改为 Out-only 行为，这等效于在 out C# 中使用 关键字 (keyword) 。 例如，按值传递的数组（默认情况下封送为仅限参数）可以更改为 Out-only。 但是，当类型包含全 blittable 元素或字段时，行为并不总是提供预期的语义，因为互操作封送处理程序使用固定。 如果不关心将数据传递到被调用方，则 Out-only 封送处理可以为非 blittable 类型提供更好的性能。

当 InAttribute 应用于数组和格式化的非 blittable 类型时，组合 和 OutAttribute 特别有用。 只有在应用这两个属性时，调用方才会看到被调用方对这些类型所做的更改。 由于这些类型需要在封送处理期间复制，因此可以使用 InAttribute 和 OutAttribute 来减少不必要的副本。

有关 对封送处理行为的影响 OutAttribute 的详细信息，请参阅 方向属性。

构造函数

属性

方法

显式接口实现

适用于

另请参阅

• InAttribute
• StringBuilder
• 可直接复制到本机结构中的类型和非直接复制到本机结构中的类型