VCFileConfiguration.Evaluate(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.11.40252

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.

Evaluates the value of a project model or environment macro. See Common Macros for Build Commands and Properties for more information about these macros.

public:
 System::String ^ Evaluate(System::String ^ bstrIn);

public:
 Platform::String ^ Evaluate(Platform::String ^ bstrIn);

std::wstring Evaluate(std::wstring const & bstrIn);

[System.Runtime.InteropServices.DispId(513)]
public string Evaluate (string bstrIn);

[<System.Runtime.InteropServices.DispId(513)>]
abstract member Evaluate : string -> string

Public Function Evaluate (bstrIn As String) As String

Parameters

bstrIn: String

Required. The macro you want to expand.

Returns

String

A string with the expanded macro.

Attributes: DispIdAttribute

Examples

The following example uses Evaluate in the integrated development environment (IDE):

' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim file As VCFile  
        Dim col As IVCCollection  
        Dim fileconfig As VCFileConfiguration  
        Dim strng As String  
        Dim prj As VCProject  
        prj = DTE.Solution.Projects.Item(1).Object  
        col = prj.Files  
        file = col.Item(1)  
        col = file.FileConfigurations  
        fileconfig = col.Item("Debug|Win32")  
        col = prj.Files  
        file = col.Item(1)  
        col = file.FileConfigurations  
        fileconfig = col.Item("Debug|Win32")  
        strng = fileconfig.Evaluate("$(TargetDir)")  
    End Sub  
End Module

Remarks

If the string you want to evaluate contains no macros, then you get exactly the same string back.

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

Applies to

Share via