Clustered Property
The Clustered property reports index clustering on Microsoft® SQL Server™ primary keys.
Applies To
| Key Object |
Syntax
object.Clustered [= value]
Part
object
Expression that evaluates to an object in the Applies To list
value
TRUE or FALSE
Data Type
Boolean
Modifiable
Read/write before the SQL Server primary key is created. Read-only when the Key object references an existing primary key.
Prototype (C/C++)
HRESULT GetClustered(LPBOOL pRetVal);
HRESULT SetClustered(BOOL NewValue);
Remarks
The Clustered property has meaning when the Key object references a SQL Server table primary key. If the Key object references a foreign key, the value is always FALSE.
If TRUE, the referenced primary key either has, or will be created with, a clustered index supporting it.
If FALSE, the referenced primary key has, or will be created with, a nonclustered index. The default for new Key objects is FALSE.