Function Executor GUI Reference

Show this topic in Library frames

This section describes the objects on the Function Executor graphical user interface (GUI).

Application Window (32-Bit)

Main Window (16-Bit)

The following GUI features are only present in the 32-bit version.

Open File Dialog GUI Reference

Create a File Dialog GUI Reference

Create a File Dialog GUI Reference (Advanced)

Transactions GUI Reference

File Statistics GUI Reference

History GUI Reference

Application Window (32-Bit)

Click on an area of the image to learn more.


GUI Object	Description	Related Information
File menu	Allows you to perform the following commands and Btrieve operations: Login Logout Open Close New Print Setup Set Owner Clear Owner Start Continuous Operations End Continuous Operations Reset Stop Exit	Performing Operations Tasks Opening a File Tasks Login Tasks
Get menu	Allows you to perform the following Btrieve operations: Get First Get Next Get Previous Get Last Get Greater Than Get Greater or Equal Get Less Get Less or Equal	Performing Operations Tasks
GetExt menu	Allows you to perform the following Btrieve operations: Goto Percent Get Position Find Percent	Performing Operations Tasks
Step menu	Allows you to perform the following Btrieve operations: Step First Step Next Step Previous Step Last	Performing Operations Tasks
Updates menu	Allows you to perform the following Btrieve operations: Insert Update Delete You can also release locks using this menu.	Performing Operations Tasks
View menu	Allows you to display GUI elements: Toolbars (main and transactions) History window File statistics window Engine version using the Btrieve Version operations	History Tasks File Statistics Tasks
Tools menu	Allows you to perform the following Btrieve operations: Get Directory Set Directory
Window menu	Allows you to perform windowing operations: Cascade windows Tile windows Select from a list of open windows
Help menu	Allows you to select from a list of help resources for this utility.	To get help for a status code
Open button	Displays the Open File dialog so that you can select a Btrieve file to open.	Opening a File Tasks
Create button	Displays the Create New File dialog so that you can create a new Btrieve file.	Creating a Btrieve File Tasks
Reset button	Resets the current client connection (Btrieve operation 28) and closes all files opened with that client ID.
Stop button	Terminates transactional services (Btrieve operation 25) and closes all open files.
Statistics button	Displays a dialog box listing the currently opened file's statistics. You can print these statistics to a text file or save them to a description file usable by BUTIL -CREATE	File Statistics Tasks
Version button	Displays information about the version of Pervasive.SQL (using Btrieve operation 26) that you are running. If no file is open, you will see information about the requester DLLs and any local MicroKernel engine. If you open a file on a remote server, you will see information about the server and requester DLLs.
Status Codes Help button	If no file is open, displays Status Codes help file. If file is open and a status code is active, displays help for that particular status code.
Show help button	Toggles whether a pop-up dialog displays when a non-zero status code is received.
Show history button	Toggles whether the History window is displayed.	To display the History window History GUI Reference History Log
Operation count	Indicates the current operation number. This is used when you set the Repeat to a value greater than one.	Performing Operations Tasks
Transaction state	Indicates the current state of any transactions. Can be: Blank, if no transaction is in effect Concurrent Exclusive	Performing Operations Tasks Transactions GUI Reference

Main Window (32-Bit)

A main window displays for every open file. Click on an area of the image to learn more.


GUI Object	Description	Related Information
Title Bar	Lists the full path of the open data file.	To open a data file with the Win32 Function Executor:
Data Buffer	Specifies a data value. For read and write operations, the Data Buffer contains records. For other operations, the Data Buffer contains file specifications, filtering conditions, and other information the MicroKernel needs for processing the operation. This control corresponds with the Data Buffer parameter.
Key Buffer	Specify the path for the data file for which you want to perform a Btrieve operation.
Step vs. Get	Toggles between Step and Get operations
Get/Step First	Performs the Get or Step Next operation	Performing Operations Tasks
Get/Step Prev	Performs the Get or Step Previous operation	Performing Operations Tasks
Get/Step Next	Performs the Get or Step Next operation	Performing Operations Tasks
Get/Step Last	Performs the Get or Step Last operation	Performing Operations Tasks
Get Equal	Performs the Get Equal operation	Performing Operations Tasks
Get Less Than	Performs the Get Less Than operation	Performing Operations Tasks
Get Greater Than	Performs the Get Greater Than operation	Performing Operations Tasks
Get Less or Equal Than	Performs the Get Less or Equal Than Operation	Performing Operations Tasks
Get Greater or Equal Than	Performs the Get Greater or Equal Than Operation	Performing Operations Tasks
Get/Find Percent	Performs the Get or Find Percent operations	Performing Operations Tasks
Insert	Performs the Insert operation	Performing Operations Tasks
Update	Performs the Update operation	Performing Operations Tasks
Delete	Performs the Delete operation	Performing Operations Tasks
Cancel	Cancels the recent changes
Unlock	Releases any locks.
Set or Goto Bookmark	Sets or positions at a previously defined bookmark.
Key Num	For most Get operations, specifies a key number, or index path, to follow for the current operation. For other operations, specifies such information as file open mode, encryption, or logical disk drive. This control corresponds with the Key Number parameter.
Key Only	Specifies to get key only, not data.
Repeat	Repeats the operation the number of times you specify.
Locks	Specifies the locking behavior you want in for the current operation.
Op Code	Specifies the current operation code plus its bias (if any). The default is 0. If you are familiar with Btrieve operation codes, you can enter the desired code. Otherwise, use the List box to specify an operation. This control corresponds with the Operation Code parameter.	Performing Operations Tasks
Execute button	Performs the currently specified operation.	Performing Operations Tasks
Operations list	Lists all Btrieve operations and their codes. The default is Open (0). You can move quickly through the list by entering the first letter of the operation you want to perform.	Performing Operations Tasks
DataLen	Specifies the length (in bytes) of the Data Buffer. The default is 1024. For every operation that requires a data buffer, you must specify a buffer length. On many operations, the MicroKernel returns a value to the Data Length. Generally, you should always specify a Data Length before you execute an operation. This control corresponds with the Data Buffer Length parameter.	Performing Operations Tasks
Status Code Indicator	Displays a numeric status code returned by the MicroKernel and a brief message explaining the result of a Btrieve operation. For detailed information about these status codes and messages, refer to the Status Codes and Messages manual.	To get help for a status code
Continuous Operations Indicator	Displays the following on the bottom row of the file window if the file is in Continuous Operations mode (operation 42).	Using Continuous Operations

Main Window (16-Bit)

Click on an area of the image to learn more.

Table 12-2 lists the controls available in the Win16 version of the Function Executor. Some of the controls correspond to Btrieve operation parameters.

Table 12-2 Win16 Function Executor Controls
GUI Element	Description	Related Information
File	Lists the full path of all open data files and displays the current open file. You can move among open files, but you cannot open a file using this box. To open a file, refer to Opening a File Tasks . This control corresponds with the Position Block parameter. Because each file name represents a position block, a file name can appear more than once in the list if the file has been opened more than once.	To start the Win16 Function Executor utility To open a data file with the Win16 Function Executor:
Transaction	Indicates whether the current operation occurs inside a transaction and the type of transaction, as follows: Exclusive - Exclusive transaction. Concurrent - Concurrent transaction. Conc+ModLk - Concurrent transaction with Modify Lock (+500) bias.	Performing Operations Tasks
Operation
Current	Specifies the current operation code plus its bias (if any). The default is 0. If you are familiar with Btrieve operation codes, you can enter the desired code. Otherwise, use the List box to specify an operation. This control corresponds with the Operation Code parameter.	Performing Operations Tasks
Last	Displays the code of the last operation that was executed on the current file.	Performing Operations Tasks
List	Lists all Btrieve operations and their codes. The default is Open (0). You can move quickly through the list by entering the first letter of the operation you want to perform.	To open a data file with the Win16 Function Executor:
Get Key Bias (+50)	Instructs the MicroKernel to return only a key value, not a data record, on the current Get operation.
Modify Lock Bias (+500)	Instructs the MicroKernel to set a no-wait lock bias on an insert, update, or delete operation executed within a concurrent transaction.
Read Lock Bias	Adds one of five biases to the current operation, as follows. For files in exclusive transactions, the MicroKernel ignores any lock bias values you specify explicitly. No Lock - Performs no locking. (Default) Single Wait (+100) - Attempts to lock a single record; if the record is already locked, it waits until the record is free. Single No Wait (+200) - Attempts to lock a single record and returns control if the record is already locked. Multiple Wait (+300) - Attempts to lock multiple records in the same file; if the records are already locked, it waits until the records are free. Multiple No Wait (+400) - Attempts to lock multiple records in the same file and returns control if the records are already locked.
Key
Number	For most Get operations, specifies a key number, or index path, to follow for the current operation. For other operations, specifies such information as file open mode, encryption, or logical disk drive. This control corresponds with the Key Number parameter.
Buffer	Specify the path for the data file for which you want to perform a Btrieve operation.
Position	Indicates the position of the cursor within the Key buffer.
Hex Display	Click this check box to view the data in Hex format.
Clear	Click this button to clear the buffer field so that you can enter another data file.
Data
Length	Specifies the length (in bytes) of the Data Buffer. The default is 1024. For every operation that requires a data buffer, you must specify a buffer length. On many operations, the MicroKernel returns a value to the Data Length. Generally, you should always specify a Data Length before you execute an operation. This control corresponds with the Data Buffer Length parameter.
Buffer	Specifies a data value. For read and write operations, the Data Buffer contains records. For other operations, the Data Buffer contains file specifications, filtering conditions, and other information the MicroKernel needs for processing the operation. This control corresponds with the Data Buffer parameter.
Position	Indicates the position of the cursor within the Key or Data Buffer.
Hex Display	Click this check box to view the data in Hex format.
Clear	Click this button to clear the buffer field so that you can enter another data file.
Status	Displays a numeric status code returned by the MicroKernel and a brief message explaining the result of a Btrieve operation. For detailed information about these status codes and messages, refer to the Status Codes and Messages manual.
Execute	Performs the currently specified operation.	Performing Operations Tasks

Note
The Win16 version of the utility performs wait lock simulation. Win16 applications cannot go into a wait loop. If you ask for a record lock using a Wait Bias and the record is locked by someone else, the engine returns Status Code 84 or 85 immediately to the application.

The Win16 Function Executor utility retries the operation until it gets the record or you click Abort which is displayed in the lower right corner of the Main window.

Login GUI Reference

This dialog allows you to perform the Btrieve login operation using a graphical interface to specify the database URI. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
Server	Specifies the server where the database you wish to login to resides.	Login Tasks
Database	Specifies the database on the server to which you want to authenticate.	Login Tasks
User Name	The user name you want to authenticate against the database.	Login Tasks
Password	The password for the user name.	Login Tasks
Client ID	If you want this login to apply to a specific client ID, click Use and specify the range. Otherwise, leave as-is.	Login Tasks
URI String	As you enter information in the forms, the URI resulting from your selections is shown in this area.	Login Tasks
Login button	Click Login to attempt the Btrieve login information using the URI specified.	Login Tasks

Open File Dialog GUI Reference

This dialog allows you to open a file with a graphical interface. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
Filename	Specifies the server where the database you wish to login to resides.	Opening a File Tasks
Owner name	Specifies the database on the server to which you want to authenticate.	Opening a File Tasks
Mode	The user name you want to authenticate against the database.	Opening a File Tasks
Client ID	If you want this login to apply to a specific client ID, click Use and specify the range. Otherwise, leave as-is.	Opening a File Tasks
Sharing	As you enter information in the forms, the URI resulting from your selections is shown in this area.	Opening a File Tasks
Open button	Click Login to attempt the Btrieve login information using the URI specified.	Opening a File Tasks

Create a File Dialog GUI Reference

This dialog allows you to open a file with a graphical interface. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
Filename	Specifies the server where the database you wish to login to resides.	Creating a Btrieve File Tasks
Owner name	Specifies the database on the server to which you want to authenticate.	Creating a Btrieve File Tasks
Mode	The user name you want to authenticate against the database.	Creating a Btrieve File Tasks
Client ID	If you want this login to apply to a specific client ID, click Use and specify the range. Otherwise, leave as-is.	Creating a Btrieve File Tasks
Sharing	As you enter information in the forms, the URI resulting from your selections is shown in this area.	Creating a Btrieve File Tasks
Open button	Click Login to attempt the Btrieve login information using the URI specified.	Creating a Btrieve File Tasks

Create a File Dialog GUI Reference (Advanced)

This dialog allows you to open a file with a graphical interface. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
Filename	Specifies the server where the database you wish to login to resides.	Creating a Btrieve File Tasks
Owner name	Specifies the database on the server to which you want to authenticate.	Creating a Btrieve File Tasks
Mode	The user name you want to authenticate against the database.	Creating a Btrieve File Tasks
Client ID	If you want this login to apply to a specific client ID, click Use and specify the range. Otherwise, leave as-is.	Creating a Btrieve File Tasks
Sharing	As you enter information in the forms, the URI resulting from your selections is shown in this area.	Creating a Btrieve File Tasks
Open button	Click Login to attempt the Btrieve login information using the URI specified.	Creating a Btrieve File Tasks

Transactions GUI Reference

This dialog allows you to control transactions during your Function Executor session. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
Main application window	Main features of the program.	See Application Window (32-Bit)
Transaction type	Specifies whether you want an exclusive or concurrent transaction.
Lock information	Specifies the type of locking you want in the transaction.
Start transaction button	Starts a transaction.
Commit transaction button	Commits the active transaction.
Abort transaction button	Cancels the active transaction and rolls back any changes made.
File area	This area contains one or more open files.	See Main Window (32-Bit)
Transaction indicator	Indicates whether you are currently in a transaction. If you are in a transaction, this display will show either Concurrent or Exclusive.

File Statistics GUI Reference

This dialog allows you to see all the operations you have performed. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
File information	Displays statistical information about the file.	File Statistics Tasks
Flags	Allows you to view the flags set for this file. Any flag that is set will have a check mark next to its listing in the dialog.	File Statistics Tasks
Keys	Allows you to view the keys defined in this file.	File Statistics Tasks
Key legend	Describes the single letter values that indicate Key attributes for the file. D = DUP (Duplicatable) M = MOD (Modifiable) R = REPEAT_DUPS_KEY (repeating duplicates key) A= NUL (All segment Null key) L = MANUAL_KEY (any segment null key) < = DESC_KEY (descending key value) I = NOCASE_KEY (case-insensitive key)	Key Attributes in Pervasive.SQL Programmer's Guide, which is part of the Pervasive.SQL Software Developer's Kit (SDK).
Print button	Allows you to print the file statistics. Set up the printer using the File menu.	File Statistics Tasks
Disk button	Allows you to save the current file statistics to a description file, which you can later use to make a new file with the same characteristics.	File Statistics Tasks
Exclamation point (create new file)	Allows you to create a new file based on these file statistics.	File Statistics Tasks

History GUI Reference

This dialog allows you to see all the operations you have performed. Click on an area of the image to learn about this dialog.


GUI Object	Description	Related Information
File menu	Allows you to perform the following operations: Import a history file Export a history file Close the history window
Settings menu	Allows you to specify the visual attributes of the History window. Save on Exit - specifies whether you want your customization of the History window to be saved between sessions. Defaults - Resets the History window to default settings. This removes any settings you specified. Docked - Toggles the state of the History window between a separate window and one that is attached to the Application Window (32-Bit) . Stay On Top- toggles the state of the History window between one that can lose focus and one that cannot.	To toggle the docking status of the History window To toggle the Always On Top status of the History window To reset the History window to default settings
Execute command	Loads the History Playback window
List of operations	Lists operations that you have recently performed. Each operation is logged with the following information: FileID Operation name or number depending on the status of the OpCodeNames checkbox. Status code when that operation was performed Number of times that operation was performed. Key number set for the operation. Contents of the key buffer. Contents of the data buffer.	History Tasks History GUI Reference
Logging	Toggles the inclusion of future operations in the history list.
OpCode Names	Toggles the display in the Operation column between operation code names (such as B_OPEN) and operation code numbers (such as 0 for B_OPEN)