Function Executor GUI Reference

Chapter contents

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

Application Window

Main Window

Open File Dialog

Create a Btrieve File

Create a File Dialog GUI Reference (Advanced)

Transactions

File Statistics

History

Application Window

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 and Logout Open and Close New Print Setup Set Owner and Clear Owner Start Continuous Operations or End Continuous Operations Reset, Stop, and Exit	Performing Operations Tasks Opening a File Tasks
Get menu	Allows you to perform the following Btrieve operations: Get First and Get Next Get Previous and Get Last Get Greater Than and Get Greater or Equal Get Less and 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 and Step Next Step Previous and Step Last	Performing Operations Tasks
Updates menu	Allows you to perform the following Btrieve operations: Insert, Update, and 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
Tools menu	Allows you to perform the following Btrieve operations: Get Directory and Set Directory
Window menu	Allows you to perform windowing operations: Cascade windows and 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	Displays a dialog box from which you select a Btrieve file to open.	Opening a File Tasks
Create	Displays a dialog box with which you can create a new Btrieve file.	Creating a Btrieve File Tasks
Reset	Resets the current client connection (Btrieve operation 28) and closes all files opened with that client ID.
Stop	Terminates transactional services (Btrieve operation 25) and closes all open files.
Statistics	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
Version	Displays information about the version of Pervasive PSQL (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	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	Toggles whether a pop-up dialog box displays when a non-zero status code is received.
Show history	Toggles whether the History window is displayed.	To display the History window History 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

Main Window

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 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 database engine 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 database engine 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 database engine 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

Login and Logout

The Login and Logout dialog boxes allows you to perform the Btrieve login and logout operations, respectively, for the database engine. Click on an area of the image to learn about this dialog box.

Figure 12-2 Login Dialog

Figure 12-3 Logout Dialog


GUI Object	Description
Server	Specifies the server where the database resides that you wish to login to or logout from.
Database	Specifies the database on the server to which you want to authenticate.
User Name	The user name you want to authenticate against the database.
Password	The password for the user name.
Client ID	If you want this login or logout to apply to a specific client ID, click Use and specify the range. Otherwise, leave as is. See Client ID in Btrieve API Guide.
URI String	As you enter information in the forms, the URI resulting from your selections is shown in this area.

Open File Dialog

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


GUI Object	Description	Related Information
Filename	Specifies the location and name of the file that you want to open.	Opening a File Tasks
Owner name	Specifies a password to associate with the Btrieve file. If specified, the owner name is required to gain access to the Btrieve file. Owner name has no relation to any system user name. You can think of an owner name as a simple file password.	Opening a File Tasks See also the chapter Pervasive PSQL Security in Advanced Operations Guide.
Mode	Specifies the state of the file when it is opened. Based on the state, the database engine knows certain conditions that apply to the opened file. For example, a condition could be that the file can be read but not updated (read-only).	Opening a File Tasks See Open Modes in Btrieve API Guide for an explanation of the modes. That guide is part of the Pervasive PSQL Software Development Kit (SDK).
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	The database engine ignores the "Sharing" options. The "Sharing" options applied only to a legacy version of the engine, Btrieve 6.15.	Opening a File Tasks

Create a Btrieve File

This dialog box allows you to create a Btrieve file. Click on an area of the image to learn about this dialog box.


GUI Object	Description	Related Information
Filename	Specifies the location and name of the file that you want to create.	Creating a Btrieve File Tasks
Owner name	Specifies a password to associate with the Btrieve file. If specified, the owner name is required to gain access to the Btrieve file. Owner name has no relation to any system user name. You can think of an owner name as a simple file password.	Creating a Btrieve File Tasks See also the chapter Pervasive PSQL Security in Advanced Operations Guide.
Mode	Specifies the state of the file when it is opened. Based on the state, the database engine knows certain conditions that apply to the opened file. For example, a condition could be that the file can be read but not updated (read-only).	Creating a Btrieve File Tasks See Open Modes in Btrieve API Guide for an explanation of the modes. That guide is part of the Pervasive PSQL Software Development Kit (SDK).
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	The database engine ignores the "Sharing" options. The "Sharing" options apply only to a legacy version of the database engine, Btrieve 6.15.

Create a File Dialog GUI Reference (Advanced)

This dialog box allows you to specify additional characteristics for the file being created. Click on an area of the image to learn about this dialog box.


GUI Object	Description	Related Information
Key and Segment commands	Allow you to add or delete a key or to add, insert, or delete a key segment.	Creating a Btrieve File Tasks
File Specifications	Displays and allows you to modify characteristics of the file.	Creating a Btrieve File Tasks Record and Page Compression
Statistics	Provides read-only information about the file.	Creating a Btrieve File Tasks
Key and segment matrix	Displays the keys and segments for the file, listing the starting position, length, attributes, and data type for them. Clicking on a row allows you to see and, modify if you want, information in the Key and Segment blocks.	Creating a Btrieve File Tasks
Key	Displays and allows you to modify characteristics of a key.	Creating a Btrieve File Tasks
Segment	Displays and allows you to modify characteristics of a key segment.	Creating a Btrieve File Tasks
Command buttons	Allow you create a data file, a description, or to cancel the dialog box.	Creating a Btrieve File Tasks

Transactions

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


GUI Object	Description	Related Information
Main application window	Main features of the program.	See Application Window
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
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

This dialog box allows you to see the statistics for a Btrieve file. Click on an area of the image to learn about this dialog box.


GUI Object	Description
File information	Displays statistical information about the file.
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 box.
Keys	Allows you to view the keys defined in this file.
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) See also Key Attributes in Pervasive PSQL Programmer's Guide.
Print button	Allows you to print the file statistics. Set up the printer using the File menu.
Save 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.
Exclamation point (create new file)	Allows you to create a new file based on these file statistics.

History

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


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 . 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 check box. 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
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)