GetQueryDescription(Table) Method

In This Topic

Gets the QueryDescription object associated with . This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function GetQueryDescription( _
   ByVal table As Table _
) As QueryDescription

public QueryDescription GetQueryDescription( 
   Table table
)

Parameters

table: A given Table or FeatureClass (if it is spatially enabled) that has an associated QueryDescription object.

Return Value

The QueryDescription object associated with .

Exceptions

Exception	Description
System.ArgumentNullException	table is null.
System.InvalidOperationException	table was not `originally` opened from a `Database` data store. For example, it was opened from a file or enterprise `geodatabase` data store instead.
ArcGIS.Core.Data.Exceptions.GeodatabaseException	A database-related exception has occurred.

Remarks

A QueryDescription object fully describes how a single database table or one or more database tables (specified by a valid SQL SELECT statement) should be represented as a Table or FeatureClass if the table is spatially enabled. Essentially, there are two flavors of QueryDescription. The first is created by GetQueryDescription(String). Given a table name (fully qualified or unqualified), it encapsulates all the important properties that describe the underlying single table (i.e., QueryDescription.IsQueryLayer returns false). The second flavor is created by GetQueryDescription(String,String). Given a valid SQL SELECT statement and a query layer name, it encapsulates all the important properties that describe the underlying query layer that is created from one or more tables (i.e., QueryDescription.IsQueryLayer returns true).

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

Database Class
Database Members
Overload List

Send feedback