Btrieve v6.1 for NetWare v4.0 January 1993 =========================================================================== Contents ======== General Information Installation Procedure Upgrade Information Btrieve v6.x Utilities Btrieve v6.x Status Codes STS Data Type Btrieve v6.x Program Files =========================================================================== General Information =================== This Readme document pertains to Btrieve v6.1 for NetWare v4.0. For detailed information about the Btrieve v6.1 product, refer to the "Btrieve Installation and Operation" manual. =========================================================================== Installation Procedure ====================== You can use the NetWare INSTALL utility to copy the Btrieve v6.1 program files to your server. Refer to the NetWare v4.0 documentation for a complete description of the installation procedure. =========================================================================== Upgrade Information =================== For a description of the enhancements to Btrieve v6.x, refer to "Btrieve v6.x Enhancements" in Chapter 1 of the "Btrieve Installation and Operation" manual provided with this product. Btrieve v6.x Utilities ---------------------- Btrieve Monitor utility (BTRMON.NLM) -- The Btrieve v6.x Monitor utility (BTRMON.NLM) replaces the Btrieve v5.x Console utility (BCONSOLE.NLM). NOTE: NLM applications that call Btrieve must issue a Btrieve Reset before unloading. Failure to do so may lead to a server abend when you try to use the Btrieve Monitor utility to monitor the NLM application's activity. Rebuild utility (BREBUILD.NLM) -- This new Btrieve v6.x utility allows you to upgrade Btrieve v5.x files to Btrieve v6.x. For more information on rebuilding your existing files, refer to "Rebuilding Existing Btrieve Files" in Chapter 3 of the "Btrieve Installation and Operation" manual provided with this product. NOTE: Before running the Rebuild utility (either from the command line or through the Setup utility), you must start Btrieve v6.x. NetWare Directory Services (NDS) Support utility (BDIRECT.NLM) -- This new Btrieve v6.1 utility allows you to register Btrieve v6.1 as an object with NDS. Roll Forward utilities (BROLLFWD.EXE, PBROLL.EXE, and WBROLL.EXE) -- When using Btrieve's logging feature and the Roll Forward utility, consider the following: - Btrieve does not allow a log file to contain log entries created by different versions of Btrieve. That is, all entries in a log file must be logged under the same version of Btrieve. Otherwise, Btrieve displays a system error message on the server console and ignores logging for the Btrieve file. - If you need to restart Btrieve, specify the same Index Balancing setting that was used when you first loaded Btrieve (after a backup) and performed logging. Otherwise, you may receive a Status Code 43 when you run the Roll Forward utility. - If you need to run the Roll Forward utility (for example, after a system crash), load the same version of Btrieve and specify the same Index Balancing setting that was used during logging. Otherwise, you may receive a Status Code 43. NOTE: If you want to switch to a different version of Btrieve or you want to change the Index Balancing setting, first create a backup of the Btrieve files to be logged and then delete the corresponding log files. - If you attempt to create a log file for a Btrieve file that contains records larger than 57 KB, you may receive a Status Code 43. The Btrieve v6.1 BROLLFWD.EXE file replaces the Btrieve v6.0 DBROLL.EXE. NOTE: If you are upgrading from Btrieve v6.0 to Btrieve v6.1, the NetWare v4.0 installation procedure will not overwrite the DBROLL.EXE file. Do not use DBROLL.EXE to perform the roll forward procedure with Btrieve v6.1. Btrieve v6.x Status Codes ------------------------- Status Code 11 (The specified filename is invalid) -- If you receive this status code when you open a Btrieve file using the Btrieve OS/2 Requester (BTRCALLS.DLL), make sure that you are using the latest NetWare OS/2 Requester. Status Code 43 (The specified record address is invalid) -- The Btrieve Roll Forward utility returns this status code because the address acquired from the Free Space List of the Btrieve file is different from the one received at the time when the operation was originally executed. The resulting file of the roll forward becomes out of sync with the original run. This syncronization problem occurs because different versions of Btrieve or the same Btrieve version but with a different Index Balancing setting may produce different Free Space Lists. The following is a summary of the specific conditions for which Status Code 43 can be returned: - During logging, Btrieve was loaded multiple times and the Index Balancing setting was not always the same. - A record larger than 57K is inserted or updated. - A different version of Btrieve or the same Btrieve version but with a different Index Balancing setting from what was used at logging time is now loaded (at roll forward time). To correct the synchronization problem, load the proper version of Btrieve with the proper Index Balancing setting. - You logged Btrieve operations with the Index Compaction option (/C) set on the Btrieve NLM but not on the Roll Forward utility, or vice versa. Status Code 44 (The specified key path is invalid) -- Btrieve v6.1 returns this code for some situations, in which earlier versions of Btrieve returned Status Code 82 (The application lost positioning). These situations only occur when you define the key attribute to be manual or null. If you have an existing Btrieve application that checked for Status Code 82, you may want to rewrite the application to check for Status Code 44 as well. Status Code 102 (Insufficient stack space is available) -- Btrieve v6.1 requires 3 KB of stack space. If your NLM application receives this status code, try increasing the size of your stack space. You may need to allow more than 3 KB of stack space if you are accessing files defined by NetWare SQL as being under Referential Integrity (RI) constraints. Because Btrieve uses recursion when enforcing the RI constraints, you will need 3 KB of stack space for each level of recursion. STS Data Type ------------- Btrieve v6.1 supports a longer STS data type than NetWare SQL. Make sure that the length of the STS data type does not exceed 15 bytes if you plan to use the Btrieve v6.1 files with NetWare SQL. =========================================================================== Btrieve v6.x Program Files ========================== Btrieve files can be grouped into the following categories: - Files related to server operations - Files related to DOS workstation operations - Files related to Windows workstation operations - Files related to OS/2 workstation operations The following lists describe the files in each category. - Files related to server operations: BDIRECT.NLM NDS Support utility that allows you to install or remove a Btrieve Server object. BDIRECT.MSG Message file for BDIRECT.NLM. BDROUTER.NLM NLM that allows server-based Btrieve applications to access Btrieve databases on remote servers and also provides NDS support in NetWare v4.0. BDROUTER.MSG Message file for BDROUTER.NLM. BREBUILD.NLM Rebuild utility that lets you convert existing Btrieve v5.x files to Btrieve v6.x format. BREBUILD.MSG Message file for BREBUILD.NLM. BROUTER.NLM NLM that allows server-based Btrieve applications to access Btrieve databases on remote servers. BROUTER.MSG Message file for BROUTER.NLM. BSETUP.NLM Btrieve installation and configuration utility. BSETUP.HLP Help file for BSETUP.NLM. BSETUP.MSG Message file for BSETUP.NLM. BSPXCOM.NLM SPX communications agent. BSPXCOM.MSG Message file for BSPXCOM.NLM. BSPXSTUB.NLM NLM that allows you to use the Btrieve Monitor utility (BTRMON.NLM) when BSPXCOM.NLM is not loaded. BSPXSTUB.MSG Message file for BSPXSTUB.NLM. BSTART.NCF Batch file executed to start Btrieve. This file also loads BSPXCOM.NLM, BDIRECT.NLM, and BROUTER.NLM (if Btrieve is configured to do so). BSTOP.NCF Batch file executed to stop Btrieve. This file also unloads BSPXCOM.NLM, BDIRECT.NLM, and BROUTER.NLM (if loaded). BTRIEVE.NLM Btrieve Record Manager (database engine). BTRIEVE.MSG Message file for BTRIEVE.NLM. BTRMON.NLM Btrieve Monitor utility that lets you monitor the activity of Btrieve files, users, and communications resources. BTRMON.MSG Message file for BTRMON.NLM. BTRMON.HLP Help file for BTRMON.NLM. BUTIL.NLM Btrieve Maintenance utility, which is a command line utility that allows you to create, manipulate, and recover Btrieve data files. BUTIL.MSG Message file for BUTIL.NLM. RSPXSTUB.NLM Module that resolves external references for the Btrieve Monitor utility (BTRMON.NLM) when BSPXCOM is not loaded. If you want to use the Btrieve Monitor utility to monitor outgoing requests generated by the Btrieve Message Router (BROUTER or BDROUTER) to another server and you do not want to load BSPXCOM, load RSPXSTUB instead of BSPXSTUB at the server. RSPXSTUB.MSG Message file for RSPXSTUB.NLM. - Files related to DOS workstation operations: BREQUEST.EXE Btrieve Requester for DOS. BREQUEST.MSG Message file for BREQUEST.EXE. BREQUTIL.EXE Btrieve Requester utility that allows you to stop the Requester and to obtain the Requester's version number at a DOS workstation. BREQUTIL.MSG Message file for BREQUTIL.EXE. BROLLFWD.EXE Roll Forward utility for the DOS operating environment. This utility recovers changes made to a Btrieve file between the time of the last backup and a system failure. BROLLFWD.MSG Message file for BROLLFWD.EXE. - Files related to Windows workstation operations: NOVDB.INI Btrieve initialization file for the Btrieve Windows Requester. WBROLL.EXE Roll Forward utility for the Windows operating environment. This utility recovers changes made to a Btrieve file between the time of the last backup and a system failure. WBROLLRS.DLL Resource file for WBROLL.EXE. WBTRCALL.DLL Btrieve Requester for Windows. WBTRVRES.DLL Resource file for the Btrieve Requester. WNDBCNVT.EXE Windows Conversion utility that converts the client-based Btrieve DLL (WBTRCALL.DLL) to WBTRLOCL.DLL. - Files related to OS/2 workstation operations: BTRCALLS.DLL Btrieve Requester for OS/2. NDBCNVT.EXE OS/2 Conversion utility that converts the client-based Btrieve DLL (BTRCALLS.DLL) to BTRLOCL.DLL. NDBCOMM.DLL Communications handler for the Btrieve Requester for OS/2. PBROLL.EXE Roll Forward utility for the OS/2 operating environment. This utility recovers changes made to a Btrieve file between the time of the last backup and a system failure. PBTRVRES.DLL Resource file for PBROLL.EXE.