TSqlModel.GetObject(ModelTypeClass, ObjectIdentifier, DacQueryScopes) 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

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.

Returns TSqlObjects of the specified objectType and id. Only top level ModelTypeClass types are supported by this method - the objectType parameter must be in the types returned from the TopLevelTypes method or the call will fail.

public Microsoft.SqlServer.Dac.Model.TSqlObject GetObject (Microsoft.SqlServer.Dac.Model.ModelTypeClass objectType, Microsoft.SqlServer.Dac.Model.ObjectIdentifier id, Microsoft.SqlServer.Dac.Model.DacQueryScopes queryScopes);

member this.GetObject : Microsoft.SqlServer.Dac.Model.ModelTypeClass * Microsoft.SqlServer.Dac.Model.ObjectIdentifier * Microsoft.SqlServer.Dac.Model.DacQueryScopes -> Microsoft.SqlServer.Dac.Model.TSqlObject

Public Function GetObject (objectType As ModelTypeClass, id As ObjectIdentifier, queryScopes As DacQueryScopes) As TSqlObject

Parameters

objectType: ModelTypeClass

Type filter. Must be in the list of ModelTypeClass types returned from the TopLevelTypes method or the call will fail.

id: ObjectIdentifier

Unique identity of TSqlObject to return.

queryScopes: DacQueryScopes

Scope filter for queried objects.

Returns

TSqlObject

Single TSqlObject or null.

Exceptions

DacModelException

If the supplied objectType and id result in multiple TSqlObjects, or if the objectType is not a top level type.

ArgumentNullException

If the supplied objectType is null.

RemotingException

If communication with the Microsoft.SqlServer.Dac.Model.TSqlObjectService fails.

Applies to