This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.CMake.

Summary

Contains settings for CMake build mode.

Assembly

Cake.CMake.dll

Namespace

Cake.CMake

Base Types

graph BT Type-->Base0["ToolSettings"] Type["CMakeBuildSettings"] class Type type-node

Syntax

public class CMakeBuildSettings : ToolSettings

cmake --build <dir> [<options>] [-- <build-tool-options>]

Name	Summary
CMakeBuildSettings()

Name	Value	Summary
BinaryPath	DirectoryPath	Gets or sets the project binary directory to be built.
CleanFirst	bool	Gets or sets a value indicating whether build target clean first, then build. (To clean only, use --target clean.)
Configuration	string	Gets or sets the configuration for multi-configuration tools. --config <cfg> The configuration.
Options	ICollection<string>	Gets or sets CMake build options.
Targets	ICollection<string>	Gets or sets the targets. Build passed target instead of the default target.

Name	Value	Summary
Dump<CMakeBuildSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<CMakeBuildSettings>(CMakeBuildSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<CMakeBuildSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<CMakeBuildSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<CMakeBuildSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<CMakeBuildSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin