ModelPropertyClass.IsDefaultValue Method

SQL Server 2014
 

Updated: April 20, 2017

Returns a Boolean value that indicates whether the value is the platform default value.

Namespace:   Microsoft.SqlServer.Dac.Model
Assembly:  Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

NameDescription
System_CAPS_pubmethodIsDefaultValue(TSqlObject, SqlServerVersion)

Returns a Boolean value that indicates whether the value is the platform default value.

System_CAPS_pubmethodIsDefaultValue(TSqlObject, SqlServerVersion, Int32)

Returns a Boolean value that indicates whether the value is the platform default value.

Return to top

ModelPropertyClass.IsDefaultValue Method (TSqlObject, SqlServerVersion)

Returns a Boolean value that indicates whether the value is the platform default value.

public bool IsDefaultValue(
	TSqlObject instance,
	SqlServerVersion version
)

Parameters

instance
Type: Microsoft.SqlServer.Dac.Model.TSqlObject

The TSqlObject instance to determine the default property value for.

version
Type: Microsoft.SqlServer.Dac.Model.SqlServerVersion

The SqlServerVersion to determine the default value for.

Return Value

Type: System.Boolean

true if the property is the platform default; otherwise, false.

Exception Condition
DacModelException

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

Return to top

ModelPropertyClass.IsDefaultValue Method (TSqlObject, SqlServerVersion, Int32)

Returns a Boolean value that indicates whether the value is the platform default value.

public bool IsDefaultValue(
	TSqlObject instance,
	SqlServerVersion version,
	int engineVersion
)

Parameters

instance
Type: Microsoft.SqlServer.Dac.Model.TSqlObject

TSqlObject instance to determine the default property value for.

version
Type: Microsoft.SqlServer.Dac.Model.SqlServerVersion

The SqlServerVersion to determine the default value for.

engineVersion
Type: System.Int32

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

Return Value

Type: System.Boolean

true if the property is the platform default; otherwise, false.

Exception Condition
DacModelException

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

Return to top

Community Additions

ADD
Show: