DtoIndexes Collection

A collection of DtoIndex objects representing the indexes of a table.


Count	Returns the number of members in a collection.
Item	Returns a specific member of a DtoIndexes collection. You can pass either a 1-based ordinal or the name of the Index.

Methods

Add method

Remove method

Clear method

Remarks

Use the Count property to find the number of members in the collection.

Example

’ Instantiate and open dictionary

Dim dictionary as new DtoDictionary

Dim result as DtoResult

result = dictionary.Open("d:\mydemodata")

’ Get STUDENT table from MYDEMODATA database

Dim students_table as DtoTable

Set students_table = dictionary.Tables("STUDENT")

’ Retrieve DEMODATA indexes collection

Dim students_idx as DtoIndexes

Set students_idx = students_table.Indexes

Add an item to a collection.

Syntax

result = Collection.Add(Object)

Arguments


Collection	Collection to add object to.
Object	A new DtoIndex object to add to the DtoIndexes collection.

Return Values


result	DtoResult long value indicating the result of the method call. Use the Error property of the DtoSession Object to obtain a description for the result.

Remarks

This method takes a parameter of type DtoIndex. Therefore, you are responsible for first instantiating the object and setting its properties before adding it to the collection.

Note: You cannot use this method to add indexes to preexisting PSQL tables. This method does not alter data or DDF files, and can only be used to add indexes in memory before a table is created. See the example for AddTable method as a reference.

Remove method

Removes an item from a collection.

Syntax

result = Collection.Remove(index)

Arguments


Collection	Collection from which to remove object.
index	A variant containing either the index (starting with 1) or the name of the item you wish to remove from the DtoIndexes collection

Return Values


result	DtoResult long value indicating the result of the method call. Use the Error property of the DtoSession Object to obtain a description for the result.

Remarks

You can pass either a name or a 1-based ordinal to the Remove method.

Note: You cannot use this method to remove indexes from preexisting PSQL tables. This method does not alter data or DDF files, and can only be used to remove indexes in memory before a table is created. See the example for AddTable method as a reference.

Clear method

Removes all items from a DtoColumns or DtoIndexes collection.

Syntax

result = Collection.Clear

Arguments


Collection	DtoIndexes collection obtained from a DtoTable object

Return Values


result	DtoResult long value indicating the result of the method call. Use the Error property of the DtoSession Object to obtain a description for the result.

Remarks

This method removes all the indexes from a table in memory.

Note: You cannot use this method to remove indexes from preexisting PSQL tables. This method does not alter data or DDF files, and can only be used to remove all indexes in memory before a table is created. See the example for AddTable method as a reference.