DefaultParameterValueAttribute クラス

.NET Framework クラス ライブラリ リファレンス

DefaultParameterValueAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

既定のパラメータをサポートする言語から呼び出された場合に、パラメータの既定値を設定します。このクラスは継承できません。

名前空間: System.Runtime.InteropServices
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Parameter)> _
Public NotInheritable Class
 DefaultParameterValueAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As DefaultParameterValueAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Parameter)] 
public sealed class DefaultParameterValueAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Parameter)] 
public ref class DefaultParameterValueAttribute
 sealed : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Parameter) */ 
public final class DefaultParameterValueAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Parameter) 
public final class DefaultParameterValueAttribute
 extends Attribute

解説

DefaultParameterValueAttribute 属性により、既定のパラメータをサポートする言語で既定のパラメータ値を指定できます。この属性をコードに適用すると、既定のパラメータをサポートする言語は、指定した値を既定のパラメータとして使用できるようになります。

DefaultParameterValueAttribute は、この機能をサポートしない言語には既定のパラメータのサポートを追加しません。たとえば、既定のパラメータをサポートしない C# で記述したメソッドで DefaultParameterValueAttribute を使用しても、C# からメソッドを呼び出して既定のパラメータを使用することはできません。既定のパラメータは、この機能をサポートする C++ などの言語でメソッドを呼び出す場合にのみ使用できます。

DefaultParameterValueAttribute は、COM 相互運用インターフェイスのメソッドに対して既定のパラメータを指定する場合に特に便利です。

使用例

C# で記述されたメソッドのパラメータに DefaultParameterValueAttribute 属性を適用する方法を次のコード例に示します。

C#

static public void MethodWithDefaultParam([System.Runtime.InteropServices.DefaultParameterValue("DEFAULT_PARAM_VALUE")]
 string var)
{
    Console.WriteLine("The passed value is: " + var);
}

継承階層

System.Object
   System.Attribute
    System.Runtime.InteropServices.DefaultParameterValueAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DefaultParameterValueAttribute メンバ
System.Runtime.InteropServices 名前空間