Apollo API Listing > Function Listing

The following section contains a listing of the Apollo API, grouped into their major operational categories.

Table and Structure Creation

sx_CopyFile	Copies the current table to another file.
sx_CopyFileText	Copy the current table to an ASCII text file.
sx_CopyStructure	Creates a table that has the same structure as the current table.
sx_CopyStructureExtended	Creates a table that holds the record structure of the currently selected file.
sx_CreateExec	Creates a table in the work area set up via sx_CreateNew and according to the field specifications defined with sx_CreateField.
sx_CreateField	Defines a field to be included in a new table.
sx_CreateFrom	Creates a new file from the specified structure extended file.
sx_CreateNew	Initializes a new work area.

Table Data Updates and Modifications

sx_Append	Places a new, empty record buffer in Edit mode.
sx_AppendBlank	Places a new, empty record buffer in Edit mode.
sx_AppendBlankEx	Places a new, empty record buffer in Edit mode, and returns a result code.
sx_AppendEx	Places a new, empty record buffer in Edit mode, and returns a result code.
sx_AppendFrom	Appends data from a source table to the current table.
sx_Commit	Writes the contents of the record buffer to the current file position.
sx_DbfDecrypt	Decrypts a table that has been encrypted at the file level.
sx_DbfEncrypt	Encrypts all records in a table.
sx_Delete	Flags the current record for deletion.
sx_Pack	Removes all records marked for deletion from a table.
sx_PutBlob	Stores a BLOB in a memo field.
sx_PutRecord	Replaces an entire record with the contents of a defined record structure or character buffer.
sx_PutVariant	Replace the contents of a field with a variant value.
sx_Recall	Recalls a record that has been logically deleted.
sx_Replace	Replaces the named field's contents in the record buffer with the given data value.
sx_Zap	Remove all records from the table.

Data Retrieval

sx_BlobToFile	Writes a BLOB stored in a memo file directly to a new disk file.
sx_GetBitMap	Sends a bitmap that was stored in a memo file to a defined window using a Windows Clipboard function.
sx_GetBlob	Retrieves a BLOB that was stored in a memo field.
sx_GetByte	Extracts the first character of a field.
sx_GetDateJulian	Extracts the contents of a date field as a Julian number.
sx_GetDateString	Extracts the contents of a date field as a string formatted according to the date mask specified by sx_SetDateFormat and the setting of sx_SetCentury.
sx_GetDouble	Extracts the contents of a numeric field and convert to a double value.
sx_GetInteger	Extracts the contents of a numeric field as a signed integer value.
sx_GetLogical	Determines whether a logical field contains a True or False value.
sx_GetLong	Extracts the contents of a numeric field as a signed long integer value.
sx_GetMemo	Extracts the contents of a memo field as a PChar and optionally format the memo with hard carriage returns and line feeds for printing.
sx_GetRecord	Fills a defined and initialized buffer or record structure with the contents of the current record buffer.
sx_GetString	Extracts the contents of any field (less than 256 bytes wide) as a string value.
sx_GetTrimString	Extracts the contents of any field as a string and trim trailing spaces.
sx_GetVariant	Extracts the contents of any field type as a Visual Basic variant type.

General Table and Workarea Information

sx_Alias	Retrieves the table alias name assigned to the current work area when the table was opened.
sx_BaseDate	Retrieves the date on which the table was last opened for read/write access.
sx_BaseName	Extracts the DOS path and file name attached to the current work area.
sx_Bof	Tests if a skip has been attempted that would place the record pointer before the first record in the file.
sx_Close	Closes the table for the current workarea.
sx_DBFilter	Extracts the current filter conditional expression.
sx_Deleted	Determines whether or not the current record has been logically deleted.
sx_Eof	Tests if a record movement function has placed the record pointer beyond the last record in the file.
sx_FieldCount	Extracts the number of fields in the current table.
sx_FieldDecimals	Extracts the number of decimals defined for a numeric field.
sx_FieldName	Extracts the name of the nth field.
sx_FieldNum	Gets number of named field in field array (relative to 1).
sx_FieldOffset	Gets offset of named field in record buffer (relative to 1).
sx_FieldType	Reports the type of the named field.
sx_FieldWidth	Extracts the width of the named field.
sx_GetBlobLength	Retrieves the length of a BLOB that was stored in a memo field.
sx_GetScope	Gets the original value of a scoping string passed to sx_SetScope.
sx_IsEncrypted	Determines whether the current record or file is encrypted.
sx_RecCount	Extracts the physical number of records in the current table.
sx_RecNo	Extracts the current physical record number.
sx_RecSize	Extracts the size of a record in the current table in number of bytes.
sx_Select	Selects an existing work area and make it the current work area.
sx_SetPassword	Defines an encoding key to be used in encrypting and decrypting data records in the current table.
sx_SetTurboRead	sx_SetTurboRead is used to speed up record i/o functions (specifically sx_Skip and sx_Seek).
sx_Use	Opens a table in a new workarea.
sx_WorkArea	Retrieves the table numeric work area identifier associated with a given alias name.

Table Navigation

sx_Go	Goes to a physical record that occupies the nth position in the table.
sx_GoBottom	Moves the record pointer to the last record in the file.
sx_GoTop	Moves to the first record in the file.
sx_SetRelation	Defines a relationship between the current table and another table.
sx_Skip	Skips forwards or backwards a specified number of records.

Index Creation and Manipulation

sx_CloseIndexes	Closes all open index files attached to the current work area.
sx_Index	Creates a new single-order (.NTX or .IDX) index file and make it the active order.
sx_IndexClose	Closes the current index file.
sx_IndexCondition	Extracts the conditional expression from the current index.
sx_IndexFlip	Dynamically toggles the Ascending/Descending status of the active index order.
sx_IndexKey	Extracts the contents of the xBase key construction expression used by the current index as a string.
sx_IndexKeyField	Extracts the name of the first field in an index key expression.
sx_IndexName	Extracts the DOS file name and path of the defined index.
sx_IndexOpen	Opens an index file.
sx_IndexOrd	Gets the current order number identifying the order work area.
sx_IndexTag	Creates a new tag in the compound .CDX or .NSX index.
sx_IndexType	Gets the current index or Tag type.
sx_KeyAdd	Adds a key to the specified index order.
sx_KeyData	Extracts the key data from the current index key in the current index and returns it as a string.
sx_KeyDrop	Removes a key from the specified index order.
sx_OrderRecNo	Retrieves the logical record number according to the position of the key in the current active order.
sx_Reindex	Rebuilds all active orders attached to the current work area.
sx_RYOKeyAdd	Adds a key to an existing sxChar RYO index tag that points to the current table record.
sx_RYOKeyDrop	Drops a key from an existing sxChar RYO index tag that points to the current table record.
sx_SetOrder	Selects an existing order as the controlling index order.
sx_TagArea	Retrieves the index select area of the named tag within a compound index.
sx_TagName	Retrieves the name of the tag associated with the passed tag area number.

Querying Data and Expressions

sx_Count	Extracts the number of records in the table, respecting any active filter.
sx_Empty	Determines whether or not the named field is empty.
sx_EvalLogical	Evaluates a logical xBase expression and retrieves a True or False value depending upon the outcome.
sx_EvalNumeric	Evaluates an xBase expression that returns a numeric value and convert the result to a double precision number.
sx_EvalString	Evaluates an xBase expression and retrieves the result as a string.
sx_EvalTest	Tests the validity of an xBase expression.
sx_FilterAlias	Assigns an alias name to a field name in the table to be used in an upcoming sx_FilterDlg call.
sx_FilterDlg	Displays a modal dialog box that allows the user to create a custom filter expression visually.
sx_Found	Queries the result of the last index seek made on the current work area.
sx_Locate	Initializes or continues a record location command.
sx_GetQueryBit	Get the setting of a bit that maps to a record number in an existing bitmap.
sx_Query	Sets an ultra high speed filter.
sx_QueryRecCount	Extracts the number of records contained in the current query subset.
sx_QueryTest	Tests if a given xBase expression will result in an optimized query set or not.
sx_RYOFilterActivate	Activates an existing filter bitmap and either make it the filter bitmap of record or combine it with the current active bitmap.
sx_RYOFilterCopy	Copies the existing filter bitmap to the linked list of RYO Filter bitmaps.
sx_RYOFilterCreate	Creates an empty bitmap to be used in subsequent RYO Filter functions.
sx_RYOFilterDestroy	Destroys a bitmap created by sx_RYOFilterCreate or sx_RYOFilterCopy
sx_RYOFilterGetBit	Gets a bit corresponding to the table record.
sx_RYOFilterSave	Saves the defined bitmap in a disk file.
sx_RYOFilterRestore	Sets or resets the active bitmap to one saved to disk by sx_RYOFilterSave
sx_RYOFilterSetBit	Sets or resets a bit corresponding to the specified table record.
sx_Seek	Searches the current order for a supplied key.
sx_SeekBin	Searches the current order for a supplied key. The key may contain binary zeroes.
sx_SetFilter	Defines a subset of the current table according to the condition passed.
sx_SetQueryBit	Sets a bit (on or off) in a query bitmap for the specified record number.
sx_SetScope	Sets formal scope based on current index order expression.

Record and File Locking

sx_DBRlockList	Retrieve a lock array of record numbers and place it in a pre-dimensioned array of long integers.
sx_Flock	Locks the current table.
sx_Locked	Determines the lock status of a record or a file.
sx_Rlock	Locks the defined record.
sx_Unlock	Removes record and/or file locks from the current work area.

Conversion

sx_Descend	Converts a key string into a 2s complement representation.
sx_RecToString	Converts a reference to a record structure into a Visual Basic string.
sx_SetTranslate	Automatically translates record buffers stored in the OEM character set to Windows ANSI.

Miscellaneous

sx_Decrypt	Decrypts an encrypted string using the specified password.
sx_Encrypt	Encrypts a string using the specified password.
sx_SetGaugeHook	Defines a window that time consuming operations may communicate with in order to inform the user as to the progress of the operation.
sx_SysProp	Sets or Retrieves SDE system information.
sx_Version	Extracts the name and version number currently in use.