Function Library Listing

 

Activity tracking

Activity_GetBackgroundStatus()

Ascertains whether the runtime engine’s process queue contains any background procedures.

Activity_GetExitMode()

Ascertains the mode used to exit the runtime engine.

Activity_GetResourceName()

Returns a string containing a resource’s display name.

 

Auto-complete

AutoComplete_AddStringValue()

Adds an auto-complete value for the specified field.

AutoComplete_RemoveAllData()

Removes all of the auto-complete data for the user currently logged into the workstation.

AutoComplete_RemoveFieldData()

Removes the auto-complete data for the specified field for the user currently logged into the workstation.

AutoComplete_RemoveStringValue()

Removes the specified string from the auto-complete data for the specified field.

AutoComplete_SetMode()

Enables or disables auto-complete for the application.

AutoComplete_SetOptions()

Sets options for auto-complete functionality.

 

Color

Color_ConvertNameToValue()

Converts a Dexterity predefined color name to the corresponding color value.

Color_ConvertRGBToValue()

Converts red, green and blue color levels to a color value.

Color_ConvertValueToName()

Converts a color value to a corresponding predefined color name.

Color_ConvertValueToRGB()

Converts a color to its component red, green and blue color levels.

Color_GetFromDialog()

Opens a color selection dialog that allows the user to pick a color.

Color_ResetSystemColor()

Sets the specified system color category back to the default value, which is derived from the current operating system settings.

Color_SetSystemColor()

Sets a system color category to the specified color.

 

COM

COM_AttachEventHandler()

Attaches a callback object as an event handler.

COM_CreateObject()

Creates a COM object reference to a new instance of an object.

COM_DetachEventHandler()

Detaches the event handler from a callback object in your Dexterity-based application.

COM_GetObject()

Retrieves a reference to the instance of an object that exists in the running object table.

COM_RegisterRunningObject()

Adds the specified callback object to the running object table.

COM_RevokeRunningObject()

Removes a callback object from the running object table.

 

Command

Command_Execute()

Performs the action for the specified command.

Command_GetAccelerator()

Retrieves the shortcut that is defined for the command.

Command_GetBooleanProperty()

Retrieves a specified boolean property for a command.

Command_GetIDs

Retrieves the resource IDs of the dictionary that contains the command, the form on which the command is defined, and the command itself.

Command_GetImageProperty()

Retrieves the specified image defined for a command.

Command_GetNamedProperty()

Retrieves the value of a specific named property that has been added to a command.

Command_GetStringProperty()

Retrieves a specified string property for a command.

Command_GetTag()

Retrieves the tag associated with the specified command or command list.

Command_GetType()

Retrieves the type of a specific command.

Command_Reset()

Returns the settings for a command back to their original state as defined in the dictionary.

Command_SetAccelerator()

Sets the shortcut that is defined for the command.

Command_SetBooleanProperty()

Sets a specified boolean property for a command.

Command_SetImageProperty()

Sets the specified image defined for a command.

Command_SetNamedProperty()

Temporarily adds a property with the specified name to a command. It then sets the value for the property.

Command_SetStringProperty()

Sets a specified string property for a command.

 

Command bar

CommandBar_Create()

Creates a toolbar based on the specified command list.

CommandBar_Destroy()

Removes a toolbar based on the specified command list.

CommandBar_GetPosition()

Retrieves the row and position of a toolbar that is based on the specified command list.

 

Command list

CommandList_Add()

Adds a command or another command list to the specified command list.

CommandList_FindCommand()

Retrieves the position of the specified item in a command list.

CommandList_GetCommandByPosition()

Retrieves the tag for a command, based on the position in the command list.

CommandList_NumCommands()

Retrieves the number of commands in the specified command list.

CommandList_Remove()

Removes the specified item from a command list.

CommandList_RemoveAll()

Removes all items from the specified command list.

CommandList_RemoveCommandByPosition()

Removes the item from the specified position in a command list.

 

Currency

Currency_GetDecimalSymbol()

Returns the string used as a decimal separator.

Currency_GetLeadingSymbol()

Returns a boolean indicating whether the currency symbol is positioned before the currency value.

Currency_GetLeadingZero()

Returns a boolean indicating whether a currency value less than 1 and greater than -1 will be displayed with a leading zero.

Currency_GetNativeSymbol()

Returns a platform-specific string displaying the dollar, pound, yen or Euro currency symbol.

Currency_GetNegativeAfterValue()

Returns a boolean value indicating whether the negative symbol is placed after the currency value.

Currency_GetNegativeBeforeSymbol()

Returns a boolean indicating whether a leading negative symbol is placed before a leading currency symbol.

Currency_GetNegativeParens()

Returns a boolean indicating whether parentheses are used to denote a negative currency value.

Currency_GetNegativeSymbol()

Returns the string used as the negative symbol.

Currency_GetNumberOfDecimals()

Returns the number of digits that will appear to the right of a currency value’s decimal separator.

Currency_GetSymbol()

Returns the string used as a currency symbol.

Currency_GetThousandsSymbol()

Returns the string used as a thousands separator.

Currency_SetDecimalSymbol()

Defines a string to use as a decimal separator.

Currency_SetLeadingSymbol()

Specifies whether the currency symbol should appear before or after the value.

Currency_SetLeadingZero()

Defines whether a leading zero will be displayed with a currency value less than 1 and greater than -1.

Currency_SetNegativeAfterValue()

Defines whether the negative symbol is placed after the value.

Currency_SetNegativeBeforeSymbol()

Defines whether a leading negative symbol is placed before or after a leading currency symbol.

Currency_SetNegativeParens()

Defines whether parentheses are used to denote a negative value.

Currency_SetNegativeSymbol()

Defines a string to be used as a negative symbol.

Currency_SetNumberOfDecimals()

Defines the number of digits that will appear to the right of the decimal separator.

Currency_SetSymbol()

Defines a string to use as a currency symbol.

Currency_SetThousandsSymbol()

Defines a string to use as a thousands separator.

 

Defaults file

Defaults_Read()

Reads the value of a setting in the Dexterity defaults file.

Defaults_ReadColor()

Reads a color value from the Defaults file.

Defaults_Write()

Writes a setting to the Dexterity defaults file.

 

Dexterity object

DexObject_AddProperty()

Adds a field to a callback object.

DexObject_AddMethod()

Adds a method to a callback object.

DexObject_Create()

Creates a callback object.

 

Dictionary

Dict_CountCustomResource()

Returns the number of forms in the forms dictionary, or the number of reports in the reports dictionary.

Dict_GetCustomResourceInfo()

Returns information about a form in a forms dictionary, or a report in a reports dictionary.

Dict_GetName()

Returns the operating system name of the current dictionary.

Dict_GetPathname()

Returns the generic path of various components of the current installation, such as the runtime engine or launch file.

Dict_LockCustom()

Opens and locks a forms or reports dictionary.

Dict_UnlockCustom()

Releases the lock added by Dict_LockCustom().

Dict_UpdateFormsDictionary()

Updates existing new and modified reports to work with the new version of an application.

Dict_UpdateReportsDictionary()

Upgrades existing modified forms to work with the new version of an application.

 

Exception handling

Exception_Class()

Returns the class of the current exception.

Exception_ClassName()

Returns a string containing the constant for the class of the current system exception.

Exception_Message()

Returns a string describing the current exception.

Exception_Product()

Returns the ID of the product that threw the current exception.

Exception_SubClass()

Returns the subclass of the current exception.

Exception_SubClassName()

Returns a string containing the constant for the subclass of the current system exception.

 

Field

Field_BDLCreateSubmenu()

Adds a submenu to a button drop list control.

Field_BDLAddToSubmenu()

Adds an item to a submenu of a button drop list control.

Field_GetBooleanProperty()

Retrieves a specified boolean property for a field.

Field_GetCaption()

Retrieves the text caption for the specified field.

Field_GetColor()

Retrieves color information for a field.

Field_GetFont()

Retrieves the font characteristics for a field.

Field_GetImage()

Retrieves the item numbers of the images associated with a push button or button drop list field.

Field_GetInsertPosFromVisualPos()

Retrieves the insertion position of an item in a list field based on its visual position.

Field_GetIntegerProperty()

Retrieves a specified integer property for a field.

Field_GetPosition()

Returns the current coordinates of the named field’s top left corner.

Field_GetRequiredStatus()

Ascertains the status of the Show Required Fields menu item.

Field_GetSelection()

Retrieves the selected text from a text field.

Field_GetSize()

Retrieves the horizontal and vertical size of a window field.

Field_GetStringProperty()

Retrieves a specified string property for a field.

Field_GetToolTip()

Returns the tooltip associated with a window field.

Field_GetVisualPosFromInsertPos()

Retrieves the visual position of an item in a list field based on its insertion position.

Field_InsertStringInText()

Inserts a string or string field into a text field.

Field_MarkListItems()

Marks and unmarks items in a non-native list box with an asterisk.

Field_ParseText()

Parses a text field into string fields.

Field_SetAltLineColor()

Specifies colors to use for alternate lines in scrolling windows.

Field_SetBackColor()

Sets the background color of a field.

Field_SetBooleanProperty()

Sets a specified boolean property for a field.

Field_SetCaption()

Sets the text caption for the specified field.

Field_SetCustomPromptFormat()

Specifies display characteristics of prompts.

Field_SetFont()

Sets the font characteristics for a field.

Field_SetFontColor()

Sets the color of the font used for a field.

Field_SetFontSize()

Sets the size of the font used for a field.

Field_SetFontStyle()

Sets the style of the font used for a field.

Field_SetImage()

Specifies the default image to use for a push button or button drop list field.

Field_SetIntegerProperty()

Sets a specified integer property for a field.

Field_SetPattern()

Sets the pattern used for a field.

Field_SetPatternColor()

Sets the color of the pattern used for a field.

Field_SetRequiredFormat()

Sets the style and color used for prompts linked to required fields.

Field_SetRequiredStatus()

Checks or unchecks the Show Required Fields menu item.

Field_SetSelection()

Selects text in a text field.

Field_SetStringProperty()

Sets a specified string property for a field.

Field_SetToolTip()

Sets the tooltip for a window field.

Field_SetZoomFormat()

Sets the display characteristics of text and field objects whose Zoom property is true.

 

File

File_Count()

Returns the number of files currently open, currently available and the maximum available for an application.

File_Delete()

Deletes a file at the operating system.

File_GetSize()

Retrieves the size in bytes of the specified file.

File_GetTempDirectory()

Retrieves the complete path to the local temporary folder for the current user.

File_Probe()

Indicates whether a table or file exists in the specified location.

 

File list

FileList_Add()

Adds a file to a file list.

FileList_Count()

Returns the number of files in the specified file list.

FileList_Create()

Creates a new file list.

FileList_Destroy()

Frees the memory used for a file list.

FileList_Get()

Retrieves the file information for a specific position in the file list.

FileList_Remove()

Removes the specified file list item from a file list.

FileList_ShowDialog()

Displays a file system dialog box that allows the user to select a set of files. The selected files are returned as a file list.

 

File type

FileType_CanAppend()

Indicates whether a specified file type can be appended to.

FileType_FillList()

Fills a list box with the available file types that the Report Writer can export to.

FileType_GetExtension()

Retrieves the file extension for a specified file type.

FileType_IsValid()

Indicates whether a file type is one of the valid types the Report Writer can export to.

 

Help pane

HelpPane_Create()

Creates a docked HTML Help pane on the right side of the application’s display area

HelpPane_Destroy()

Removes the docked HTML Help pane from the right side of the application’s display area.

HelpPane_DisplayTopic()

Displays the specified topic from an compiled HTML Help file in the docked help pane.

HelpPane_GetWidth()

Retrieves the width of the docked HTML Help pane in the application.

HelpPane_SetTitle()

Specifies the title that will appear at the top of the docked HTML Help pane on the right side of the application’s display area.

HelpPane_SetWidth()

Specifies the width of the docked HTML Help pane on the right side of the application area.

HelpPane_Show()

Causes the docked HTML Help pane to be shown or hidden in the application.

 

Import

Import_CloseFile()

Closes the text file opened using Import_OpenFile().

Import_GetNextField()

Returns the value of the current field, and advances to the next field in a record.

Import_GetNextRecord()

Advances to the next record or line in the text file.

Import_OpenFile()

Opens a specified text file and reserves a file ID.

 

IP

IP_GetIPName()

Returns the host name of the current workstation.

IP_GetIPNumber()

Returns the IP address of the current workstation.

IP_PingDPS()

Pings a Process Server workstation to determine whether the Process Server is running.

 

Launch

Launch_CountProds()

Counts the number of products listed in the launch file.

Launch_FillListWithProds()

Fills a list field with product names listed in the current launch file.

Launch_GetFileInfo()

Fills list fields with product names, product IDs and dictionary location IDs from the launch file.

Launch_GetFileName()

Returns the full generic path and launch file name for the currently-running application.

Launch_GetProdID()

Returns a product ID based upon a product’s position in the launch file.

Launch_GetProdName()

Returns a product’s name from the launch file based upon its product ID.

Launch_GetProdPosition()

Returns the position of the product in the launch file.

Launch_ParseFileFromPath()

Parses a file’s operating system name from a generic pathname.

Launch_ReadDictPath()

Returns the location of an application, forms or reports dictionary from the launch file.

Launch_SelectDict()

Displays an operating system dialog box, from which you can select a dictionary location.

Launch_SelectFile()

Displays an operating system dialog box, from which you can select a launch file.

Launch_WriteDictPath()

Writes the location of an application, forms or reports dictionary to the launch file.

 

ListView

ListView_ColumnAdd()

Adds a column to the list view field.

ListView_ColumnCount()

Retrieves the total number of columns that have been added to a list view field.

ListView_ColumnGetAlignment()

Retrieves the alignment of the specified column of a list view field.

ListView_ColumnGetLabel()

Retrieves the label of the specified column of a list view field.

ListView_ColumnGetPosition()

Retrieves the position of the specified column of a list view field.

ListView_ColumnGetSubitem()

Retrieves the number of the subitem associated with the column.

ListView_ColumnGetWidth()

Retrieves the width, in pixels, of the specified column.

ListView_ColumnRemove()

Removes the specified column from a list view field.

ListView_ColumnSetAlignment()

Specifies the alignment of a column in a list view field.

ListView_ColumnSetLabel()

Sets the label of the specified column of a list view field.

ListView_ColumnSetPosition()

Sets the position of the specified column of a list view field.

ListView_ColumnSetWidth()

Sets the width of the specified column.

ListView_GetClickItem()

Returns the index of the item that was most recently clicked.

ListView_GetSortColumn()

Returns information for the column by which the list view field is being sorted.

ListView_GetStringWidth()

Returns the number of pixels required to fully display a string in the current font of a specified list view field.

ListView_GetView()

Retrieves the current view mode for the specified list view field.

ListView_ItemAdd()

Adds an item to a list view field.

ListView_ItemCount()

Retrieves the number of items currently in a list view field.

ListView_ItemGetCurrencySubitem()

Retrieves a currency or variable currency value from the additional component of a subitem.

ListView_ItemGetData()

Retrieves the long integer data item associated with the specified list view item.

ListView_ItemGetDateSubitem()

Retrieves a date value from the additional component of a subitem.

ListView_ItemGetImage()

Retrieves the item numbers of the images associated with the specified list view item.

ListView_ItemGetIntSubitem()

Retrieves an integer or long integer value from the additional component of a subitem.

ListView_ItemGetLabel()

Retrieves the label of the specified list view item.

ListView_ItemGetStateImage()

Retrieves the item number of the state image associated with the specified list view item.

ListView_ItemGetSubitem()

Retrieves a subitem from the specified list view item.

ListView_ItemGetTimeSubitem()

Retrieves a time value from the additional component of a subitem.

ListView_ItemMakeVisible()

Makes the specified item in a list view field visible.

ListView_ItemRemove()

Removes the specified item from a list view field.

ListView_ItemSetCurrencySubitem()

Sets the value of the additional component of a subitem to a currency or variable currency value.

ListView_ItemSetData()

Sets the data item associated with the specified list view item.

ListView_ItemSetDateSubitem()

Sets the value of the additional component of a subitem to a date value.

ListView_ItemSetImage()

Sets the item image associated with the specified list view item.

ListView_ItemSetIntSubitem()

Sets the value of the additional component of a subitem to an integer or long integer value.

ListView_ItemSetLabel()

Sets the label of the specified list view item.

ListView_ItemSetStateImage()

Sets the state image associated with the specified list view item.

ListView_ItemSetSubitem()

Sets the value of a subitem for the specified list view item.

ListView_ItemSetTimeSubitem()

Sets the value of the additional component of a subitem to a time value.

ListView_SelectionCount()

Retrieves the number of items currently selected in a list view field.

ListView_SelectionGet()

Retrieves the item index of the specified item in the selection.

ListView_SelectionSet()

Changes the selection in a list view field.

ListView_SetEmptyMessage()

Specifies the message to display when the list view doesn’t contain any items.

ListView_SetSortColumn()

Specifies the column by which a list view field is sorted.

ListView_SetView()

Sets the view mode for the specified list view field.

ListView_Sort()

Sorts the items in a list view field.

 

Login

Login_AlterLogin()

Changes the characteristics of a SQL login.

Login_CreateLogin()

Creates a new SQL login.

Login_DropLogin()

Drops a SQL login.

Login_ExitDataSource()

Disconnects a user from the current data source.

Login_GetDataSources()

Fills a list box or drop-down list with the names of all available data sources.

Login_GetDBMSInfo()

Retrieves information about the ODBC driver and data source being used

Login_GetInfo()

Returns the names of the data source and user ID associated with the current client’s connection to the server.

Login_GetLoginSettings()

Retrieves the login options for the specified SQL login.

Login_LogIntoDataSource()

Logs the user into the named data source.

Login_LogIntoDataSourceEx()

Logs the user into the named data source. It also supports the additional password features available for SQL Server 2005.

Login_OpenDexDialog()

Logs a user into the named data source using Dexterity’s predefined Login window.

Login_VerifyInfo()

Verifies whether the specified user ID and password are a valid combination for access to the named data source.

 

MAPI

MAPI_AddAddress()

Adds an address to the specified address list.

MAPI_CountAddresses()

Returns the number of addresses in the specified address list.

MAPI_CreateAddressList()

Creates a list that will contain addresses to which a mail message will be sent.

MAPI_DestroyAddressList()

Removes the specified address list from memory.

MAPI_DisplayDialog()

Displays the MAPI message addressing dialog.

MAPI_GetAddress()

Retrieves an address from the specified address list.

MAPI_IsLoggedOn()

Indicates whether the application is logged on to a MAPI session.

MAPI_IsMailEnabled()

Indicates whether the current workstation supports MAPI.

MAPI_ProfileGetAddress()

Retrieves the name and e-mail address from the profile for the current user.

MAPI_LogOff()

Closes the MAPI session on the current workstation.

MAPI_LogOn()

Creates a MAPI session on the current workstation.

MAPI_PropertyListCount()

Retrieves the number of properties in a property list.

MAPI_PropertyListCreate()

Creates a list that will contain properties that specify characteristics of an e-mail message.

MAPI_PropertyListDestroy()

Removes the specified property list from memory.

MAPI_PropertyListGetValue()

Retrieves the value of a property from the specified property list.

MAPI_PropertyListGetValueByIndex()

Retrieves the value of a property from the specified property list, based on the index.

MAPI_PropertyListSetValue()

Sets the value of a property in the specified property list.

MAPI_RemoveAddress()

Removes an address from the specified address list.

MAPI_ResolveAddress()

Attempts to match a search string to an e-mail address in the address book.

MAPI_Send()

Sends a message to the members of a specified address list.

MAPI_SendDialog()

Sends a message to the members of a specified address list. A mail dialog will be displayed for each message sent.

 

Menu

Menu_Invoke()

Causes a menu item to be invoked, just as if it had been selected by the user.

 

Menu bar

MenuBar_AddMenu()

Adds a command list to the menu bar.

MenuBar_RemoveAllMenus()

Removes all menus from the menu bar.

MenuBar_RemoveMenu()

Removes the specified menu from the menu bar.

 

OLE

OLE_CloseNote()

Closes the specified OLE container file.

OLE_DeleteNote()

Closes the specified OLE container file (if open) and deletes it.

OLE_Exit()

Closes the OLE container application.

OLE_IsNoteEnabled()

Ascertains whether the current operating environment can support the OLE container application.

OLE_OpenNote()

Opens the specified OLE container file and sets the window title of the OLE container application.

OLE_SaveNote()

Saves the specified OLE container file.

 

Path

Path_ChangeDefault()

Changes the default location for tables with a Pathname table series.

Path_CreateFolder()

Creates a new folder or directory.

Path_DoesExist()

Indicates whether the specified path exists.

Path_GetForApp()

Returns the generic path of various components of the current installation, such as the runtime engine or launch file.

Path_MakeGeneric()

Converts a native pathname to a generic pathname.

Path_MakeNative()

Converts a generic pathname to a native pathname.

Path_ParseFileFromPath()

Parses a file’s operating system name from a generic path.

Path_ParsePathFromPath()

Parses the path name from a generic path.

Path_SelectPathname()

Allows a user to indicate the location of a file, and returns a generic pathname to that location.

 

Printer

Printer_Define()

Allows a Windows user to define a named printer destination.

Printer_GetName()

Returns the name of a printer defined using the Printer_Define() function.

Printer_SetDestination()

Changes the application’s default printer destination on a Windows workstation.

 

Registry

Registry_DeleteKey()

Deletes the specified key from the registry

Registry_DeleteValue()

Deletes the specified value from the registry.

Registry_GetProtectedString()

Retrieves and decrypts the specified value from the HKEY_CURRENT_USER subtree and key.

Registry_GetValue()

Retrieves the specified value from the registry.

Registry_SetKeyValue()

Sets the specified value in the registry.

Registry_SetProtectedKeyString()

Encrypts and sets the specified value for the HKEY_CURRENT_USER subtree and key.

 

Report

Report_Begin()

Starts a Quick Report.

Report_DoubleLine()

Draws a double line in the current band.

Report_End()

Completes the processing of a Quick Report.

Report_GetPageRemaining()

Returns how much vertical area of the page remains, not including the current band.

Report_GetPageSize()

Returns the printable width and height of the page, based on the settings for the currently-selected printer.

Report_GetStringWidth()

Returns the width of a string using the font, size, and style specified.

Report_NewBand()

Creates a new band in the report.

Report_NewPage()

Creates a new page for the report.

Report_ReadyToRun()

Verifies that a new Quick Report can be run.

Report_SetFont()

Specifies the characteristics of the font to use for the Quick Report.

Report_SingleLine()

Draws a single line in the current band.

Report_WriteText()

Adds a text string to the current band.

 

Resource

Resource_EndSeriesFill()

Releases resources that have been read into memory by the Resource_StartSeriesFill() function.

Resource_FillSeriesList()

Fills two list fields with the display names and technical names of resources of a specified resource type and series.

Resource_GetDisplayName()

Returns a string containing the display name of a specified resource in an application dictionary.

Resource_GetID()

Returns the resource ID for a specified resource type and name.

Resource_GetInfo()

Returns the resource ID and resource name for a form, report, table or table group for a specified series.

Resource_GetNthResource()

Returns the resource ID, name, and series of the specified resource.

Resource_GetResourceName()

Returns the name for a specified resource type and ID.

Resource_GetSubResourceName()

Returns the name for a specified subresource of a primary resource.

Resource_StartSeriesFill()

Returns the number of resources of a specific type for a series.

 

Runtime

Runtime_GetCPUType()

Returns information about the processor on which the application is being run.

Runtime_GetCurrentProductID()

Returns the product ID of the application dictionary that contains the script executing this function.

Runtime_GetModuleInfo()

Retrieves the major and minor version numbers and the build number from the application dictionary.

Runtime_GetOSBuildInfo()

Returns build information for the operating system on which the application is being run.

Runtime_GetOSInfo()

Returns information about the operating system on which the application is being run.

Runtime_GetVersionNum()

Returns a string describing the current version of the runtime engine.

Runtime_SetAboutMenu()

Allows you to change the application name in the About menu item.

Runtime_SetFieldEnterMode()

Changes the functionality of the enter key to act as the tab key.

Runtime_SetIcon()

Allows you to specify which icons will be displayed in the application.

 

Script log

ScriptLog_Start()

Starts logging scripts, writing the script log to the specified output file.

ScriptLog_Stop()

Stops logging scripts, closing the current output file.

 

Script profiler

ScriptProfile_Clear()

Clears the script profile currently in memory.

ScriptProfile_Save()

Saves the script profile currently in memory to the specified output file.

ScriptProfile_Start()

Causes the application to start profiling scripts.

ScriptProfile_Stop()

Causes the application to stop profiling scripts.

 

Shell

Shell_DisplayNotification()

Causes a notification to be displayed in the lower-right corner of the display.

 

SQL

SQL_Clear()

Clears any results sets and errors for the specified pass-through SQL connection.

SQL_Connect()

Creates a new pass-through SQL connection.

SQL_Execute()

Executes a SQL string.

SQL_FetchNext()

Retrieves the next row from the current results set.

SQL_GetData()

Returns data in the specified column in the current row of the current results set.

SQL_GetError()

Returns information about the last error that occurred.

SQL_GetNextResults()

Moves to the next results set.

SQL_GetNumCols()

Returns the number of columns in the current results set.

SQL_GetNumRows()

Returns the number of rows that were affected by a write operation.

SQL_Terminate()

Deletes the specified pass-through SQL connection.

 

Table

Table_AutoShrink()

Shrinks a data table and rebuilds the table’s indexes.

Table_Compare()

Compares the structure of an existing table in the current data source to that table’s definition in the application dictionary.

Table_CopyShrinkRecords()

Copies a record from an original table to a temporary table created using Table_StartShrink().

Table_CreateIndexes()

Creates the indexes for the specified table on a data source.

Table_CreateProcedures()

Creates the stored procedures for the specified table on a data source.

Table_DisableErrorChecks()

Allows Dexterity to ignore automatic error checking for table operations.

Table_DropProcedures()

Drops the stored procedures for the specified table on a data source.

Table_EndConversion()

Finishes a table conversion.

Table_EndShrink()

Closes the shrink table and finishes the table shrink.

Table_FillGroupList()

Fills a list field with the names of the table groups from a series.

Table_FillList()

Fills a list field with the names of tables from the specified table group.

Table_FlushCache()

Clears the table cache for all closed tables.

Table_GetAutoShrinkMode()

Indicates whether the current database manager is capable of conducting a table shrink using Table_AutoShrink() or rebuilding a table’s indexes using Table_RebuildIndexes().

Table_GetDisplayName()

Returns the display name for a specified table.

Table_GetFieldList()

Retrieves the names of the fields in the specified table.

Table_GetGroup()

Returns the resource ID of the table group a specified table is part of.

Table_GetKeyInfo()

Returns information about a key in the specified table.

Table_GetOSName()

Returns the operating system name being used for the specified table.

Table_GetRangeKey()

Retrieves the key used for the range applied to the specified table.

Table_GetSeries()

Returns an integer corresponding to the series the specified table is part of.

Table_GetSQLErrorText()

Retrieves a block of SQL error text for the last SQL error that occurred.

Table_IsRangeSet()

Ascertains whether a range is currently set for the specified table.

Table_OpenAsTemp()

Creates a “clone” of the table specified. The clone will be a temporary table with exactly the same structure as the table supplied.

Table_RebuildIndexes()

Rebuilds the indexes for a table that stores data using the

c-tree Plus database manager.

Table_SetCreateMode()

Allows you to choose whether tables that don’t already exist will be created automatically at runtime.

Table_SetDBType()

Sets a default database type for an application.

Table_SetDeleteOptions()

Allows you to choose whether a delete all or drop will be executed when the delete table statement is used.

Table_SetRefreshFlags()

Sets the refresh flags for each client buffer associated with the named table.

Table_StartConversion()

Opens the old and new table definitions for exclusive use so data can be converted.

Table_StartShrink()

Creates a temporary data table that can be used to store data from an original table that’s being shrunk.

Table_Truncate()

Removes all records from a named table, leaving the table structure intact in the database.

Table_VerifyRecord()

Verifies the contents of the fields in a record for the specified table.

 

Text file

TextFile_Close()

Closes a text file opened by the TextFile_Open() function.

TextFile_Open()

Opens a specified text file.

TextFile_ReadLine()

Reads a line from a file opened by the TextFile_Open() function.

TextFile_ReadText()

Reads a specified number of characters from a text file opened by the TextFile_Open() function.

TextFile_WriteDOS()

Writes a line to a text file opened by the TextFile_Open() function, using the DOS text format.

TextFile_WriteLine()

Writes a line to a text file opened by TextFile_Open().

TextFile_WriteText()

Writes a line to a text file opened by the TextFile_Open() function without including a line feed or carriage return.

 

Timer

Timer_Sleep()

Causes the application to wait for the specified period of time.

 

Tools

Tools_CloseDUOSTable()

Closes the DUOS table available to the Visual Basic® for Applications (VBA) environment.

Tools_DisableLoadBalancing()

Disables load balancing on a process server or client workstation.

Tools_EnableCommandMenus()

Causes command-based menus to be used for an application, rather than resource-defined menus.

Tools_EnableCustomizationMaintenance()

Enables the Customization Maintenance menu item.

Tools_EnableCustomizationStatus()

Enables the Customization Status menu item.

Tools_EnableImport()

Enables the Import Utility.

Tools_EnableLoadBalancing()

Enables load balancing on a process server or client workstation.

Tools_EnableModifier()

Enables the Modifier.

Tools_EnableReportWriter()

Enables the Report Writer.

Tools_GetTranLevel()

Indicates whether a database transaction is currently active.

Tools_IsAppProcessServer()

Returns whether the application is running on the Process Server.

Tools_IsScriptRemote()

Returns whether the current script is being processed remotely on a process server.

Tools_OpenDUOSTable()

Opens the DUOS table available to the Visual Basic for Applications (VBA) environment.

 

Tree view

TreeView_AddNode()

Adds a new child node to the specified node in a tree view field.

TreeView_CollapseNode()

Collapses the specified node.

TreeView_CountChildren()

Returns the number of children for the specified node.

TreeView_CountNodes()

Returns the entire number of nodes in a tree view field.

TreeView_ExpandNode()

Expands the specified node.

TreeView_GetClickNode()

Returns the ID of the node whose state image was clicked.

TreeView_GetCollapsingNode()

Returns the ID of the node that is being collapsed.

TreeView_GetExpandingNode()

Returns the ID of the node that is being expanded.

TreeView_GetFirstChild()

Returns the ID of the first child node for the specified parent node.

TreeView_GetNextNode()

Returns the ID of the next sibling for the specified node.

TreeView_GetNodeData()

Returns the long integer data item associated with a node.

TreeView_GetNodeImage()

Returns an integer indicating the image associated with a node.

TreeView_GetNodeLabel()

Returns the label for the specified node.

TreeView_GetNodeStateImage()

Retrieves the item number of the state image associated with the specified node.

TreeView_GetParent()

Returns the node ID of the parent of the specified node.

TreeView_GetPreviousNode()

Returns the ID of the preceding sibling for the specified node.

TreeView_GetRootNode()

Returns the ID of the first root-level node.

TreeView_GetSelectedNode()

Returns the ID of the currently-selected node.

TreeView_IsParentNode()

Indicates whether a specific node is a parent node.

TreeView_MakeNodeVisible()

Ensures that the specified node is visible in the tree.

TreeView_RemoveChildren()

Removes the child nodes for the specified parent node.

TreeView_RemoveNode()

Deletes the specified node.

TreeView_SetNodeData()

Sets the data item associated with the specified node.

TreeView_SetNodeImage()

Specifies the image to use for the specified node.

TreeView_SetNodeLabel()

Sets the label for the specified node.

TreeView_SetNodeStateImage()

Sets the state image associated with the specified node.

TreeView_SetSelectedNode()

Makes the specified node selected and visible.

 

Trigger

Trigger_CausedByProduct()

Used in a trigger processing procedure of a database trigger to find out which product caused the trigger to activate.

Trigger_DisableSingle()

Disables a specific trigger.

Trigger_Enable()

Enables or disables all client-side triggers for an application.

Trigger_EnableSingle()

Enables a specific trigger.

Trigger_GetCurrentTag

Used in a trigger processing procedure to retrieve the tag associated with the current trigger.

Trigger_IsTriggerEnabled()

Returns a boolean indicating whether a specific trigger is enabled.

Trigger_RegisterDatabase()

Registers a database trigger for use with the runtime engine.

Trigger_RegisterDatabaseByName()

Registers a database trigger for a table in the specified dictionary.

Trigger_RegisterFocus()

Registers a focus trigger for use with the runtime engine.

Trigger_RegisterFocusByName()

Registers a focus trigger for a resource in the specified dictionary.

Trigger_RegisterForm()

Registers a form trigger for use with the runtime engine.

Trigger_RegisterFormByName()

Registers a form trigger for a form in the specified dictionary.

Trigger_RegisterFunction()

Registers a function trigger for use with the runtime engine.

Trigger_RegisterFunctionByName()

Registers a function trigger for a function in the specified dictionary.

Trigger_RegisterProcedure()

Registers a procedure trigger for use with the runtime engine.

Trigger_RegisterProcedureByName()

Registers a procedure trigger for a procedure in the specified dictionary.

Trigger_Unregister()

Unregisters a specific trigger.

 

Utility

Utility_DecodeString()

Decodes a string that was encoded by the Utility_EncodeString() function.

Utility_DecryptTableString()

Decrypts a string that has been stored in a table in encrypted format.

Utility_EncodeString()

Converts a string into a format that isn’t easily readable by users or other applications.

Utility_EncryptTableString()

Encrypts a string using the same method that Dexterity uses when storing encrypted strings in tables.

Utility_LoadDLL()

Loads the specified DLL into memory.

Utility_SubstituteTokens()

Replaces product tokens in a string with the corresponding product names.

Utility_UnloadDLL()

Removes the specified DLL from memory.

 

Window

Window_ForceRedraw()

Forces a window to be redrawn.

Window_GetMainWindowTitle()

Returns the window title of a form’s main window.

Window_GetPosition()

Returns the coordinates of a window’s top left corner.

Window_GetSize()

Returns the width and height, in pixels, of a window.

Window_GetState()

Retrieves the visual state for a window.

Window_GetTitle()

Returns the title of the specified window.

Window_GetTitleByProduct()

Returns the title of a window in a specified dictionary.

Window_PullFocus()

Pulls the focus from the specified window.

Window_SetBaseSize()

Sets the size of the window without resizing any of the controls in the window.

Window_SetLineMode()

Changes the window type of the scrolling window.

Window_SetState()

Sets the visual state for a window.

 

WinHelp

WinHelp_ALinkLookup()

Starts the help engine, indicating the help file to be used, and displays the topic corresponding to the ALink (associative link) value specified.

WinHelp_GetCurWindow()

Returns the resource ID of the current window.

WinHelp_GetFieldContextNumber()

Returns the context number for the selected field.

WinHelp_GetHelpType()

Returns an integer indicating the type of help requested.

WinHelp_GetWindowContextNumber()

Returns the context number for the current window.

WinHelp_InvokeHelp()

Starts the help engine, indicating the help file, help command and context number to be used.

WinHelp_RegisterHelpProcedure()

Indicates which procedure script to call when help is accessed.

WinHelp_RunHelpMacro()

Specifies a help file and the help macro or macros to run.

WinHelp_Search()

Starts the help engine and searches for the specified keyword in the help file indicated.

 


Documentation Feedback