Vista Software
Apollo SDE API Functions
See Also
 Overview
 Features

Apollo SDE™ API Functions

The following are categorical groupings of the 32-bit API functions within the SuccessWare Database Engine (SDE) used by all Apollo products.

Download SDE with detailed help files.

Table / Structure Creation
sx_CopyFile Copies the current table to another file.
sx_CopyFileText Copies the current table to another 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 database 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 database.
sx_CreateFrom Creates a new file from the specified structure extended file.
sx_CreateNew Initializes a new work area.
Table Data Updates / Modifications
sx_Append Places a new, empty record buffer in Edit mode.
sx_AppendBlank Places a new, empty record buffer in Edit mode.
sx_AppendFrom Appends data from a source database to the current database.
sx_Commit Writes the contents of the record buffer to the current file position.
sx_DBFDecrypt Decrypts a database that has been encrypted at the file level.
sx_DBFEncrypt Encrypts all records in a database.
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_PutVariant Replace the contents of a field with a variant value (VB only).
sx_PutRecord Replaces an entire record with the contents of a defined record structure or character buffer.
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 database.
Data Retrieval
sx_BlobToFile Writes a BLOB stored in a memo file directly to a new disk file.
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.
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.
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 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 as a Visual Basic variant type. (VB only)
General Table / Workarea Information
sx_Alias Retrieves the database alias name assigned to the current work area when the database was opened.
sx_BaseDate Retrieves the date on which the database 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 an open table.
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 database.
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 database.
sx_RecNo Extracts the current physical record number.
sx_RecSize Extracts the size of a record in the current database 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 database.
sx_SetTurboRead Speed up record i/o functions (specifically sx_Skip and sx_Seek).
sx_Use Opens the specified table.
sx_WorkArea Retrieves the database 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 database.
sx_GoBottom Moves the record pointer to the last record in the file.
sx_GoTop Go to the first record in the file.
sx_SetRelation Defines a relationship between the current database and another database.
sx_Skip Skips forwards or backwards a specified number of records.
Index Creation / Manipulation
sx_CloseIndexes Closes all open index files attached to the current table object.
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 Toggles the current index view from Ascending to Descending and vice-versa.
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_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 / Expressions
sx_Count Extracts the number of records in the database, 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 database to be used in an upcoming 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_GetQueryBit Get the setting of a bit that maps to a record number in an existing bitmap.
sx_Locate Initializes or continues a record location command.
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.
sx_RYOFilterCopy Copies the existing filter bitmap to the linked list of RYO filter bitmaps.
sx_RYOFilterDestroy Destroys the specified RYO filter bitmap.
sx_RYOFilterGetBit Gets a specified bit value from the current RYO filter bitmap.
sx_RYOFilterRestore Activates an existing filter bitmap.
sx_RYOFilterSave Sets or resets the active filter bitmap to one saved to disk with sx_RYOFilterSave.
sx_RYOFilterSetBit Sets a specified bit on or off in the current RYO filter bitmap.
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 database 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 / File Locking
sx_FLock Locks the current database.
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_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_MemDealloc Deallocate memory allocated by GetMemo.
sx_SetGaugeHook Defines a window to send progress information to during time consuming operations.
sx_SysProp Sets or Retrieves ARTEMIS system information.
sx_Version Extracts the SDE version number as a string.
Back to the top
Apollo Database Engines
  

©1999-2008 Vista Software. All rights reserved.
http://www.vistasoftware.com Terms of use.