ModelPropertyClass.IsDefaultValue Method

Definition

Namespace:

Microsoft.SqlServer.Dac.Model

Assembly:

Microsoft.SqlServer.Dac.Extensions.dll

Package:

Microsoft.SqlServer.DacFx v162.2.111

Overloads

IsDefaultValue(TSqlObject, SqlServerVersion)	Returns if the value is the platform default value. Note: for SqlAzure the default value may depend on the EngineVersion being targeted. This method assumes the current default version is being used. To validate the default value based on a particular for a particular EngineVersion, please use IsDefaultValue(TSqlObject, SqlServerVersion, Int32).
IsDefaultValue(TSqlObject, SqlServerVersion, Int32)	Returns if the value is the platform default value.

IsDefaultValue(TSqlObject, SqlServerVersion)

Returns if the value is the platform default value.

Note: for SqlAzure the default value may depend on the EngineVersion being targeted. This method assumes the current default version is being used. To validate the default value based on a particular for a particular EngineVersion, please use IsDefaultValue(TSqlObject, SqlServerVersion, Int32).

public bool IsDefaultValue (Microsoft.SqlServer.Dac.Model.TSqlObject instance, Microsoft.SqlServer.Dac.Model.SqlServerVersion version);

member this.IsDefaultValue : Microsoft.SqlServer.Dac.Model.TSqlObject * Microsoft.SqlServer.Dac.Model.SqlServerVersion -> bool

Public Function IsDefaultValue (instance As TSqlObject, version As SqlServerVersion) As Boolean

Parameters

instance

TSqlObject

TSqlObject instance to determine the default property value for.

version

SqlServerVersion

The SqlServerVersion to determine the default value for.

Returns

Boolean

True if the property is the platform default. Otherwise false.

Exceptions

DacModelException

If the supplied instance is not the owner of this property.

IsDefaultValue(TSqlObject, SqlServerVersion, Int32)

Returns if the value is the platform default value.

public bool IsDefaultValue (Microsoft.SqlServer.Dac.Model.TSqlObject instance, Microsoft.SqlServer.Dac.Model.SqlServerVersion version, int engineVersion);

member this.IsDefaultValue : Microsoft.SqlServer.Dac.Model.TSqlObject * Microsoft.SqlServer.Dac.Model.SqlServerVersion * int -> bool

Public Function IsDefaultValue (instance As TSqlObject, version As SqlServerVersion, engineVersion As Integer) As Boolean

Parameters

instance

TSqlObject

TSqlObject instance to determine the default property value for.

version

SqlServerVersion

The SqlServerVersion to determine the default value for.

engineVersion

Int32

Optional value for the engine version. This maps to the EngineVersion property on a model.

Returns

Boolean

True if the property is the platform default. Otherwise false.

Exceptions

DacModelException

If the supplied instance is not the owner of this property.