ProjectItem.RemoveMetadata(String) Method

Reference

Definition

Namespace:: Microsoft.Build.Evaluation

Assembly:: Microsoft.Build.dll

Package:: Microsoft.Build v15.9.20

Package:: Microsoft.Build v16.11.0

Package:: Microsoft.Build v17.11.4

Source:: ProjectItem.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.

Removes any metadata with the specified name. Returns true if the evaluated metadata existed, otherwise false. If the metadata name is one of the built-in metadata, like "FullPath", throws InvalidArgumentException. If the metadata originates in an item definition, and was not overridden, throws InvalidOperationException.

public:
 bool RemoveMetadata(System::String ^ name);

public bool RemoveMetadata (string name);

member this.RemoveMetadata : string -> bool

Public Function RemoveMetadata (name As String) As Boolean

Parameters

name: String

The name of the metadata to remove.

Returns

Boolean

true if metadata with the given name exists before removal; otherwise, false.

Remarks

Throws InvalidArgumentException if the metadata name refers to built-in metadata, like "FullPath".

Throws InvalidOperationException if the metadata name refers to metadata that originates from an item definition.

Applies to

Share via