Share via

DictTable.Clusterindex Method

  • Reference

Definition

Namespace:
Microsoft.Dynamics.Ax.Xpp
Assembly:
Microsoft.Dynamics.AX.Xpp.Support.dll

Overloads

Clusterindex()

Returns the ID of the clustered index for the table.
Clusterindex(Boolean)

Clusterindex()

Returns the ID of the clustered index for the table.

public:
 virtual int Clusterindex();
public virtual int Clusterindex ();
abstract member Clusterindex : unit -> int
override this.Clusterindex : unit -> int
Public Overridable Function Clusterindex () As Integer

Returns

Int32

The ID of the clustered index for the table; 0 (zero) if there is no clustered index for the table.

Remarks

The following example shows the retrieval of the clustered index for a table.

DictTable dt; 
DictIndex di; 
int       i; 
dt = new DictTable(tablenum(CustTable)); 
if (dt) 
{ 
    i = dt.clusterIndex(); 
    if (0 != i) 
    { 
        di = new DictIndex(tablenum(CustTable), i); 
        print di.name(); 
    } 
}

Applies to

Clusterindex(Boolean) 

public:
 virtual int Clusterindex(bool asDefinedInAOT);
public virtual int Clusterindex (bool asDefinedInAOT);
abstract member Clusterindex : bool -> int
override this.Clusterindex : bool -> int
Public Overridable Function Clusterindex (asDefinedInAOT As Boolean) As Integer

Parameters

asDefinedInAOT
Boolean

A value that indicates whether the clustered index to retrieve is defined in the AOT. A value of true returns the clustered index as defined in the AOT. A value of false returns the clustered index as defined in the SQL table; optional.

Returns

Int32

Applies to