Function Executor Graphical User Interface

Function Executor Graphical User Interface

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

•

Application Window

•

•

Login and Logout

•

Open File Dialog

•

Create New Btrieve File Dialog

•

•

File Statistics

•

Application Window

The table below the following image explains the window components. Click an area of the image for which you want more information.

Table 61

Function Executor Application Window

Related Information

Allows you to perform the following commands and Btrieve operations:

•

Login and Logout

•

•

•

•

Set Owner Name and Clear Owner Name

•

Start Continuous Operations or End Continuous Operations

•

Reset, Stop, and Exit

Performing Operations Tasks

Opening a File Tasks

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

Allows you to perform the following Btrieve operations:

•

•

•

Performing Operations Tasks

Allows you to perform the following Btrieve operations:

•

Step First and Step Next

•

Step Previous and Step Last

Performing Operations Tasks

Allows you to perform the following Btrieve operations:

•

Insert, Update, and Delete

You can also release locks using this menu.

Performing Operations Tasks

Allows you to display GUI elements:

•

Toolbars (main and transactions)

•

•

File statistics window

•

Engine version using the Btrieve Version operations

Allows you to perform the following Btrieve operations:

•

Get Directory and Set Directory

Allows you to perform windowing operations:

•

Cascade windows and Tile windows

•

Select from a list of open windows

Allows you to select from a list of help resources for this utility.

To get help for a status code

Displays a dialog box from which you select a Btrieve file to open.

Opening a File Tasks

Displays a dialog box with which you can create a new Btrieve file.

Creating a Btrieve File Tasks

Resets the current client connection (Btrieve operation 28) and closes all files opened with that client ID.

Terminates transactional services (Btrieve operation 25) and closes all open files.

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

Displays information about the version of 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.

Toggles whether a pop-up dialog box displays when a non-zero status code is received.

Toggles whether the History window is displayed.

To display the History window

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

•

•

Performing Operations Tasks

A main window displays for every open file. Click an area of the image for which you want more information.

Table 62

Function Executor Main Window for an Open File

Related Information

Lists the full path of the open data file.

To open a data file with Function Executor

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.

Specify the path for the data file for which you want to perform a Btrieve operation.

Toggles between Step and Get operations

Performs the Get or Step Next operation

Performing Operations Tasks

Performs the Get or Step Previous operation

Performing Operations Tasks

Performs the Get or Step Next operation

Performing Operations Tasks

Performs the Get or Step Last operation

Performing Operations Tasks

Performs the Get Equal operation

Performing Operations Tasks

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

Performs the Insert operation

Performing Operations Tasks

Performs the Update operation

Performing Operations Tasks

Performs the Delete operation

Performing Operations Tasks

Cancels the recent changes

Releases any locks.

Set or Goto Bookmark

Sets or positions at a previously defined bookmark.

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.

Specifies to get key only, not data.

Repeats the operation the number of times you specify.

Specifies the locking behavior you want in for the current operation.

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

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

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 an area of the image for which you want more information.

Figure 10 Login Dialog

Figure 11 Logout Dialog

Table 63

Function Executor Login and Logout Dialogs

Specifies the server where the database resides that you wish to log in to or log out from. Note that a server name is required to access a database on a Linux or OS X operating system. See also Database URIs in PSQL Programmer's Guide.

Specifies the database on the server to which you want to authenticate.

The user name you want to authenticate against the database.

The password for the user name.

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.

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 an area of the image for which you want more information.

Table 64

Function Executor Open File Dialog

Related Information

Sets the location and name of the file that you want to open.

Opening a File Tasks

Sets a password to associate with the Btrieve file. If specified, the owner name is required to gain access to the Btrieve file. Owner names have no relation to any system user name. You can think of an owner name as a file password.

A short owner name can be up to 8 bytes. A long owner name can be up to 24 bytes. If you choose to set a long owner name, then certain restrictions apply as described under Owner Names.

Opening a File Tasks

See also the chapter PSQL Security.

Sets 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 in the Developer Reference for an explanation of the modes.

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

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 New Btrieve File Dialog

This dialog box allows you to specify additional characteristics for the file being created. Click an area of the image for which you want more information.

Table 65

Function Executor Create File Dialog (Advanced)

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

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 a row allows you to see, and modify if you want, information in the Key and Segment blocks.

Creating a Btrieve File Tasks

Displays and allows you to modify characteristics of a key.

Creating a Btrieve File Tasks

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

This dialog box allows you to control transactions during your Function Executor session. Click an area of the image for which you want more information.

Table 66

Function Executor Transactions Dialog

Related Information

Main application window

Main features of the program.

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.

This area contains one or more open files.

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 an area of the image for which you want more information.

Table 67

Function Executor File Statistics Dialog

File information

Displays statistical information about the file.

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.

Allows you to view the keys defined in this file.

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 PSQL Programmer's Guide.

Allows you to print the file statistics. Set up the printer using the File menu.

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.

This dialog box allows you to see all the operations you have performed. Click an area of the image for which you want more information.

Table 68

Function Executor History Dialog

Related Information

Allows you to perform the following operations:

•

Import a history file

•

Export a history file

•

Close the history window

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:

•

•

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.

•

•

Toggles the inclusion of future operations in the history list.

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)