Set Functions and Methods

Alpha Five provides the following methods based on the default SET object. Prefix the following methods with the SET keyword.

Method

 

Description

.ERASE()

V5

Deletes the set if safety is TRUE.

.EXTERNAL_RECORD_

CONTENT_GET()

V5

Extracts data from a set into a CR-LF delimited list.

.OPEN()

V5

Opens a set and returns a pointer to the set.

.OPEN_REPAIR()

V5

Opens an existing set, repairing problems interactively if encountered.

.OPEN_SESSION()

V5

Opens a set in a new session and returns a pointer to the set.

.SEND()

V5

Emails a set using either the Alpha Five internal email client or a third party email client.

.STRUCTURE_GET()

V5

Returns a string with information about the format of a set.

.ZIP()

V5

Zips the named set.

Alpha Five provides the following Set methods. Prefix the following methods with the <SET> pointer. Use the SET.OPEN() or SET.OPEN_SESSION() methods to return the <SET> pointer.

Function

 

Description

.CLASS()

V5

Returns the class name.

.CLOSE()

V5

Closes all of the tables in the set.

.CURRENT()

V5

Returns a pointer to the current set.

.DUPLICATE()

V5

Creates a copy of the set, with all records and layouts.

.EVAL()

V5

Evaluates an expression in the context of the set.

.EVAL_VALID()

V5

Returns TRUE if expression is valid in the context of the set.

.FETCH_EOF()

V5

Returns .T. (TRUE) if the most recent fetch in <SET> has tried to read past the end of the file, creating an end of file condition.

.FETCH_FIND()

V5

Retrieves the first record in <SET> with a primary index key equal to the Matching_Expression parameter.

.FETCH_FIRST()

V5

Retrieves the first record in <SET>.

.FETCH_GOTO()

V5

Retrieves the specified Record_Number.

.FETCH_LAST()

V5

Retrieves the last record in <SET>.

.FETCH_LOC_NEXT()

V5

Retrieves the next record in <SET> with a field value that equals Matching_Expression.

.FETCH_LOC_PREV()

V5

Retrieves the previous record in <SET> with a field value that equals Matching_Expression.

.FETCH_NEXT()

V5

Retrieves the next record in <SET>.

.FETCH_PREV()

V5

Retrieves the previous record in <SET>.

.FILENAME_GET()

V5

Gets the filename of the set.

.GET_PRIMARY()

V5

Returns a pointer to the primary table in a set

.IN_USE()

V5

Returns true. if any of the tables in a set are in use.

.IS_VALID()

V5

Returns true if the current set if valid.

.PRIMARY_GET()

V5

Retrieve the primary table for a named set.

.RENAME()

V5

Renames the set.

.SESSIONHANDLE()

V5

Returns the session that the set is opened under.

.TABLE_GET()

V5

Return a pointer to a table of an open set (primary if unnamed, else named table).

Alpha Five provides the following Set related functions and methods.

Function

 

Description

A5_PACK_SET()

V5

Packs selected tables in a set.

A5_SETS_ENUM()

V5

Returns a list of sets in the current database.

A5.SET_ENUM()

V5

Returns a list of sets.

A5_ZAP_SET()

V5

Removes records from the tables of the set but preserves the set and table structures.

<FIELD>.LINK_TYPE_GET()

V5

Returns the type of set link that the field represents.

FILES_IN_SET()

V5

Returns a CR-LF delimited character string list containing the fully qualified names of the components of the set.

LINK()

V5

If the current table is the primary table in a set, LINK returns the linking key value that relates it to the specified Child_Table_Name table.

LIST_FILES_IN_SET()

V5

Creates a CR-LF delimited character list containing the fully qualified names of the components of the set.

MRECNO()

V5

Returns the record number for a composite record in a set.

SCANNING()

V5

Returns .T. (TRUE) if the current composite record buffer includes data from Table_Name ; otherwise, it returns .F. (FALSE).

TABLES_IN_SET()

V5

Creates a character string that contains a CR-LF delimited list of files composing the set defined by Set_Name.

UI_PROMPT_NEW_SET()

V5

Displays the Specify Set Name dialog box, then returns the fully qualified name of the new set.

See Also

Table Methods for Sets