ModelPropertyClass.GetDefaultValue Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dac.Model
Assembly:
Microsoft.SqlServer.Dac.Extensions.dll
Package:
Microsoft.SqlServer.DacFx.x64 v140.3881.1
Package:
Microsoft.SqlServer.DacFx v150.5282.3
Package:
Microsoft.SqlServer.DacFx v160.6161.0
Package:
Microsoft.SqlServer.DacFx v162.2.111
Package:
Microsoft.Data.Tools.Msbuild v10.0.61804.210

Overloads

GetDefaultValue(SqlServerVersion)

Returns the default property 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 get a default value based on a particular for a particular EngineVersion, please use GetDefaultValue(SqlServerVersion, Int32).
GetDefaultValue(SqlServerVersion, Int32)

Returns the default property value.
GetDefaultValue<T>(SqlServerVersion)

Returns the default property 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 get a default value based on a particular for a particular EngineVersion, please use GetDefaultValue<T>(SqlServerVersion, Int32).
GetDefaultValue<T>(SqlServerVersion, Int32)

Returns the default property value. Note: for SqlAzure the default value may depend on the EngineVersion being targeted.

GetDefaultValue(SqlServerVersion)

Returns the default property 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 get a default value based on a particular for a particular EngineVersion, please use GetDefaultValue(SqlServerVersion, Int32).

public object GetDefaultValue (Microsoft.SqlServer.Dac.Model.SqlServerVersion version);
member this.GetDefaultValue : Microsoft.SqlServer.Dac.Model.SqlServerVersion -> obj
Public Function GetDefaultValue (version As SqlServerVersion) As Object

Parameters

version
SqlServerVersion

The SqlServerVersion to return the default value for.

Returns

Object

Default value for specified SqlServerVersion.

Applies to

GetDefaultValue(SqlServerVersion, Int32)

Returns the default property value.

public object GetDefaultValue (Microsoft.SqlServer.Dac.Model.SqlServerVersion version, int engineVersion);
member this.GetDefaultValue : Microsoft.SqlServer.Dac.Model.SqlServerVersion * int -> obj
Public Function GetDefaultValue (version As SqlServerVersion, engineVersion As Integer) As Object

Parameters

version
SqlServerVersion

The SqlServerVersion to return the default value for.

engineVersion
Int32

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

Returns

Object

Default value for specified SqlServerVersion.

Applies to

GetDefaultValue<T>(SqlServerVersion)

Returns the default property 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 get a default value based on a particular for a particular EngineVersion, please use GetDefaultValue<T>(SqlServerVersion, Int32).

public T GetDefaultValue<T> (Microsoft.SqlServer.Dac.Model.SqlServerVersion version);
member this.GetDefaultValue : Microsoft.SqlServer.Dac.Model.SqlServerVersion -> 'T
Public Function GetDefaultValue(Of T) (version As SqlServerVersion) As T

Type Parameters

T

Type of the property value.

Parameters

version
SqlServerVersion

The SqlServerVersion to return the default value for.

Returns

T

Default value for specified SqlServerVersion.

Exceptions

InvalidCastException

If the property value cannot be cast to T.

Applies to

GetDefaultValue<T>(SqlServerVersion, Int32)

Returns the default property value. Note: for SqlAzure the default value may depend on the EngineVersion being targeted.

public T GetDefaultValue<T> (Microsoft.SqlServer.Dac.Model.SqlServerVersion version, int engineVersion);
member this.GetDefaultValue : Microsoft.SqlServer.Dac.Model.SqlServerVersion * int -> 'T
Public Function GetDefaultValue(Of T) (version As SqlServerVersion, engineVersion As Integer) As T

Type Parameters

T

Type of the property value.

Parameters

version
SqlServerVersion

The SqlServerVersion to return the default value for.

engineVersion
Int32

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

Returns

T

Default value for specified SqlServerVersion.

Exceptions

InvalidCastException

If the property value cannot be cast to T.

Applies to