BuildItem.GetMetadata(String) Method

Reference

Definition

Namespace:: Microsoft.Build.BuildEngine

Assembly:: Microsoft.Build.Engine.dll

Package:: Microsoft.Build.Engine v17.11.4

Source:: BuildItem.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead: Microsoft.Build.Construction Microsoft.Build.Evaluation Microsoft.Build.Execution

Retrieves an arbitrary unevaluated metadata value from the item element. These are pieces of metadata that the project author has placed on the item element that have no meaning to MSBuild. They are just arbitrary metadata that travel around with the BuildItem wherever it goes.

public:
 System::String ^ GetMetadata(System::String ^ metadataName);

public string GetMetadata (string metadataName);

member this.GetMetadata : string -> string

Public Function GetMetadata (metadataName As String) As String

Parameters

metadataName: String

The name of the metadata to retrieve.

Returns

String

The value of the requested metadata.

Exceptions

InvalidOperationException

Thrown when the requested metadata is not applicable to the item.

Remarks

Warning