SIMPOL Documentation

sbme1newindex

Description

Objects of type sbme1newindex represent an index in a new database table associated with an SBME database file, and provide information that may be needed about the index.

Type Tags

None

Object Value

Objects of type sbme1newindex have no value, and it is an error to try to get or set this value.

Properties

PropertyTypeDescription
_type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided.
__type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property.
algorithmstring Contains the name of the algorithm for this index. If this value is the empty string ("") then the index is in order by character value.
fieldsbme1newfield Contains a reference to the first sbme1newfield object that this index is based on. Currently that is the only one.
nextsbme1newindex Contains a reference to the next sbme1newindex object for the table. The sbme1newindex objects for a table form a closed loop that is linked by this property.
precisioninteger For full precision this value must be .nul, otherwise it is a positive integer value that indicates the maximum number of characters taken from a string value, the maximum number of bytes of data taken from the most significant end of an integer value, or the maximum number of bytes taken from a blob when sorting.
tablesbme1newtable Contains a reference to the sbme1newtable object for the table that contains this index.
typetype Specifies the sbme1newindex type object.
uniqueboolean If this value is equal to .true, then the index is guaranteed to be unique and will cause an error if an attempt is made to save a record with a duplicate index value.

Methods

remove()

Description

Removes the index from its table definition.

Prototype

sbme1newindexvar.remove ( integer error )

Parameters
ParameterDefault valueType nameDescription
error.nulinteger Specifies an object that is used to output any error code generated during the execution of the method. This parameter must be an object, not an integer value. If error is not specified or is .nul then any error that occurs during object creation will halt the program. If an error object is specified and an error occurs during execution then the error code is output into that object and the method returns .nul.