TSqlModel.GetObject Method
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.
Namespace: Microsoft.SqlServer.Dac.Model
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)
Syntax
'Declaration
Public Function GetObject ( _
objectType As ModelTypeClass, _
id As ObjectIdentifier, _
queryScopes As DacQueryScopes _
) As TSqlObject
'Usage
Dim instance As TSqlModel
Dim objectType As ModelTypeClass
Dim id As ObjectIdentifier
Dim queryScopes As DacQueryScopes
Dim returnValue As TSqlObject
returnValue = instance.GetObject(objectType, _
id, queryScopes)
public TSqlObject GetObject(
ModelTypeClass objectType,
ObjectIdentifier id,
DacQueryScopes queryScopes
)
public:
TSqlObject^ GetObject(
ModelTypeClass^ objectType,
ObjectIdentifier^ id,
DacQueryScopes queryScopes
)
member GetObject :
objectType:ModelTypeClass *
id:ObjectIdentifier *
queryScopes:DacQueryScopes -> TSqlObject
public function GetObject(
objectType : ModelTypeClass,
id : ObjectIdentifier,
queryScopes : DacQueryScopes
) : TSqlObject
Parameters
- objectType
Type: Microsoft.SqlServer.Dac.Model.ModelTypeClass
Type filter. Must be in the list of ModelTypeClass types returned from the TopLevelTypes method or the call will fail.
- id
Type: Microsoft.SqlServer.Dac.Model.ObjectIdentifier
Unique identity of TSqlObject to return.
- queryScopes
Type: Microsoft.SqlServer.Dac.Model.DacQueryScopes
Scope filter for queried objects.
Return Value
Type: Microsoft.SqlServer.Dac.Model.TSqlObject
Single TSqlObject or null.
Exceptions
| Exception | Condition |
|---|---|
| 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 id is null. |
| ArgumentNullException | If the supplied objectType is null. |
| RemotingException | If communication with the TSqlObjectService fails. |