Required attributeとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

RequiredAttribute クラス

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

必要なタスクプロパティを指定するためにタスクの作成者が使用するメタデータ属性を定義します。タスクが実行されるとき、この属性を持つタスクプロパティに値が設定されている必要があります。

名前空間: Microsoft.Build.Framework
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple:=False, Inherited:=False)>
 _
Public NotInheritable Class
 RequiredAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As RequiredAttribute

[AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple=false,
 Inherited=false)] 
public sealed class RequiredAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property, AllowMultiple=false,
 Inherited=false)] 
public ref class RequiredAttribute sealed :
 public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple=false,
 Inherited=false) */ 
public final class RequiredAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property, AllowMultiple=false,
 Inherited=false) 
public final class RequiredAttribute extends
 Attribute

解説

タスクが実行されたときに、この属性が指定されたプロパティに値が割り当てられていなければ、ビルドが失敗します。

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

使用例

1 つ以上のディレクトリを作成するタスクのコードを次の例に示します。

using System;
using System.IO;
using System.Security;
using System.Collections;
using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;

namespace Microsoft.Build.Tasks
{
    /*
     * Class: MakeDir
     *
     * An MSBuild task that creates one or more directories.
     *
     */
    public class MakeDir : Task
    {
        // The Required attribute indicates the following to MSBuild:
        //         - if the parameter is a scalar type, and it is not
 supplied, fail the build immediately
        //         - if the parameter is an array type, and it is not
 supplied, pass in an empty array
        // In this case the parameter is an array type, so if a project
 fails to pass in a value for the 
            // Directories parameter, the task will get invoked, but
 this implementation will do nothing,
            // because the array will be empty.
        [Required]
            // Directories to create.
        public ITaskItem[] Directories
        {
            get
            {
                return directories;
            }

            set
            {
                directories = value;
            }
        }

        // The Output attribute indicates to MSBuild that the value
 of this property can be gathered after the
        // task has returned from Execute(), if the project has an <Output>
 tag under this task's element for 
        // this property.
        [Output]
        // A project may need the subset of the inputs that were actually
 created, so make that available here.
        public ITaskItem[] DirectoriesCreated
        {
            get
            {
                return directoriesCreated;
            }
        }

        private ITaskItem[] directories;
        private ITaskItem[] directoriesCreated;

        /// <summary>
        /// Execute is part of the Microsoft.Build.Framework.ITask interface.
        /// When it's called, any input parameters have already been
 set on the task's properties.
        /// It returns true or false to indicate success or failure.
        /// </summary>
        public override bool Execute()
        {
            ArrayList items = new ArrayList();
            foreach (ITaskItem directory in
 Directories)
            {
                // ItemSpec holds the filename or path of an Item
                if (directory.ItemSpec.Length > 0)
                {
                    try
                    {
                        // Only log a message if we actually need to
 create the folder
                        if (!Directory.Exists(directory.ItemSpec))
                        {
                            Log.LogMessage(MessageImportance.Normal, "Creating
 directory " + directory.ItemSpec);
                            Directory.CreateDirectory(directory.ItemSpec);
                        }

                        // Add to the list of created directories
                        items.Add(directory);
                    }
                    // If a directory fails to get created, log an error,
 but proceed with the remaining 
                    // directories.
                    catch (Exception ex)
                    {
                        if (ex is IOException
                            || ex is UnauthorizedAccessException
                            || ex is PathTooLongException
                            || ex is DirectoryNotFoundException
                            || ex is SecurityException)
                        {
                            Log.LogError("Error trying to create directory "
 + directory.ItemSpec + ". " + ex.Message);
                        }
                        else
                        {
                            throw;
                        }
                    }
                }
            }

            // Populate the "DirectoriesCreated" output items.
            directoriesCreated = (ITaskItem[])items.ToArray(typeof(ITaskItem));

            // Log.HasLoggedErrors is true if the task logged any errors
 -- even if they were logged 
            // from a task's constructor or property setter. As long
 as this task is written to always log an error
            // when it fails, we can reliably return HasLoggedErrors.
            return !Log.HasLoggedErrors;
        }
    }
}

継承階層

System.Object
System.Attribute
Microsoft.Build.Framework.RequiredAttribute

スレッドセーフ

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

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RequiredAttribute メンバ
Microsoft.Build.Framework 名前空間

RequiredAttribute コンストラクタ

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

RequiredAttribute クラスの新しいインスタンスを初期化します。

名前空間: Microsoft.Build.Framework
アセンブリ: Microsoft.Build.Framework (microsoft.build.framework.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New RequiredAttribute

public RequiredAttribute ()

C++

public:
RequiredAttribute ()

public RequiredAttribute ()

JScript

public function RequiredAttribute ()

.NET Framework のセキュリティ

直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
RequiredAttribute クラス
RequiredAttribute メンバ
Microsoft.Build.Framework 名前空間

RequiredAttribute プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

RequiredAttribute メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュコードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

RequiredAttribute メンバ

RequiredAttribute データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	RequiredAttribute	RequiredAttribute クラスの新しいインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュコードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッドパラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

Required attributeとは？わかりやすく解説

RequiredAttribute クラス

RequiredAttribute コンストラクタ

RequiredAttribute プロパティ

関連項目

RequiredAttribute メソッド

関連項目

RequiredAttribute メンバ

関連項目

「Required attribute」の関連用語


	© 2025 Microsoft.All rights reserved.

Required attributeとは？ わかりやすく解説

RequiredAttribute クラス

RequiredAttribute コンストラクタ

RequiredAttribute プロパティ

関連項目

RequiredAttribute メソッド

関連項目

RequiredAttribute メンバ

関連項目

急上昇のことば

「Required attribute」の関連用語

Required attributeとは？わかりやすく解説