DB2 ® IBM DB2 Content Manager OnDemand Windows Client Customization Guide SC27-0837-03 DB2 ® IBM DB2 Content Manager OnDemand Windows Client Customization Guide SC27-0837-03 Note Before using this information and the product that it supports, read the information in “Notices” on page 277. Fourth Edition (October 2004) This edition replaces SC27-0837-02. This edition applies to Version 7 Release 1 of IBM DB2 Content Manager OnDemand for z/OS and OS/390 (product number 5655-H39), Version 8 Release 3 of IBM DB2 Content Manager OnDemand for Multiplatforms (product number 5724-J33), and Version 5 of IBM DB2 Content Manager OnDemand for iSeries Common Server (product number 5722-RD1) and to all subsequent releases and modifications until otherwise indicated in new editions. This product includes software developed by the Apache Software Foundation (http://www.apache.org/). © Copyright International Business Machines Corporation 1996, 2004. All rights reserved. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this publication . vii GetFolderNames. .43 Who should use this publication . vii GetFolderSearchFieldName . .44 How this publication is organized. vii GetFolderSearchFieldNames . .45 Where to find more information . viii GetNumDocAnnotations . .47 Accessibility information for OnDemand . .x GetNumDocsInList . .48 Support available on the Web . .x GetNumFolderDisplayFields. .50 Education and training . .x GetNumFolderFields . .53 How to send your comments . .x GetNumFolders . .54 GetNumFolderSearchFields . .56 || Summary of changes. .xi GetNumServerPrinters. .58 GetNumServers . .59 GetResourceCacheMode . .61 Part 1. The OnDemand OLE control 1 GetServerName . .62 GetServerNames. .63 Chapter 1. Overview of the OnDemand GetServerPrinter. .64 OLE Control . .3 GetServerPrinterInfo . .65 GetStoreDocInvalidFieldNum . .66 Viewing multiple documents for a single folder. .3 GetTypeForDoc . .68 Header File . .3 IsDocHorzScrollRequired . .69 Return Code . .4 Logoff . .71 Logon . .72 Chapter 2. Methods . .5 OnSysColorChange . .74 AboutBox . .5 OpenDoc . .74 ActivateFolder . .5 OpenFolder . .77 AnnotateDoc . .6 PrintDoc . .79 CancelOperation . .7 RetrieveDoc . .81 ChangePassword . .8 ScrollDocHorz . .83 ClearFolderSearchFields . .9 ScrollDocVert . .86 CloseAllFolders . .10 SearchFolder . .88 CloseDoc . .11 SetDefaultFolderSearchFields . .91 CloseFolder . .11 SetDocBackgroundColor . .91 CopyBitmap . .12 SetDocCurrentPage . .92 CopyDocPagesToFile . .13 SetDocImageColor . .94 CopyText . .14 SetDocImageIntensity . .94 DeleteDoc . .15 SetDocRotation . .95 FindStringInDoc . .16 SetDocZoom . .96 GetAnnotationForDoc . .18 SetFolderCloseMemoryRelease . .98 GetAnnotationStatus . .19 SetFolderSearchFieldData . .98 GetControlId . .20 SetLogonReturnOnFailure . 101 GetDocAnnotation . .21 SetResourceCacheMode . 102 GetDocBackgroundColor . .23 SetRightButtonMenu . 103 GetDocCurrentPage . .24 SetSelectionMode . 105 GetDocDisplayValue . .25 SetServerPrinterData . 107 GetDocDisplayValues . .26 SetUserMessageMode . 108 GetDocImageColor . .28 ShowFolder . 109 GetDocImageIntensity . .29 ShowWaitCursorDuringCancelableOperation . .110 GetDocNumPages . .31 StoreDoc . 111 GetDocRotation . .32 UndoFind . .114 GetDocScrollPositions . .33 UpdateDoc . .115 GetDocType . .34 WasOperationCancelled . .116 GetDocZoom . .35 GetFolderDisplayFieldName. .36 Chapter 3. OLE Events . .119 GetFolderDisplayFieldNames . .37 FolderSearchCompleted . .119 GetFolderFieldName . .39 FolderClosed . .119 GetFolderFieldNames . .40 DocOpened . .119 GetFolderName . .42 © Copyright IBM Corp. 1996, 2004 iii DocClosed . .119 GET_DISPLAY_FIELDS . 145 AreaSelected. .119 GET_DOC_VALUES . 146 AreaDeselected . .119 GET_FOLDER_FIELDS . 147 UserCommand( long CommandID ) . 120 GET_FOLDERS. 148 GET_NUM_DOCS_IN_LIST . 148 Part 2. Windows 32-bit GUI GET_NUM_DOC_PAGES . 149 GET_PRINTERS . 149 customization guide . 121 GET_QUERY_FIELDS . 150 GET_SERVERS . 151 Chapter 4. OnDemand customization LOGOFF . 151 overview . 123 LOGON . 152 OPEN_DOC . 153 Chapter 5. Command line . 125 OPEN_FOLDER . 154 PRINT_DOC . 157 Starting OnDemand 32-bit client . 125 RESTORE_DEFAULTS . 159 Parameter Syntax . 125 RETRIEVE_DOC . 159 Parameters . 125 SEARCH_FOLDER . 161 Product Title — /T name . 125 SELECT_DOC . 161 Logon Server Name — /S name . 125 SET_FIELD_DATA . 162 Logon User ID — /U id. 126 SET_FOCUS . 163 Logon Password — /P password. 126 SET_HELP_PATH . 164 Change Password — /C new password . 126 SET_USER_MSG_MODE . 165 Folder Name — /F name . 126 SHOW_WINDOW. 165 Maximum Open Folders — /O number . 126 STORE_DOC . 166 Window Placement — /W placement . 127 UPDATE_DOC . 168 Enable DDE Interface — /I number,path,resid 127 Disable Exit — /K. 127 Disable Logoff or Password Change — /X . 127 Chapter 8. Return Codes . 171 Disable Update Servers — /Y . 128 Disable Close Folder — /Z . 128 Chapter 9. DDEML Advise Loop . 173 Disable Anticipation — /V . 128 Disable User Confirmation — /B . 128 Chapter 10. External Applications and Free Memory When Folder Closed — /Q . 128 Dynamic Link Libraries . 175 Language Path — /1 . 128 Chapter 11. Related documents . 183 Chapter 6. Dynamic Data Exchange (DDE) and DDE Management Library . 129 Chapter 12. Program Information File 187 Invoking the OnDemand 32-bit from another Windows application . 129 OnDemand invocation and DDEML initialization 130 Chapter 13. Document Audit Facility 189 DDEML termination . 131 Overview. 189 DDEML transactions . 132 Creating the DAF control file . 189 The AUDIT section . 189 Chapter 7. OnDemand DDE The folder section . 190 commands . 135 Defining the report . 190 Defining the application group . 190 ACTIVATE_DOC . 135 Defining the application . 191 ACTIVATE_FOLDER . 135 Defining the Folder . 191 ANNOTATE_DOC . 136 Controlling access to the DAF . 191 ARRANGE_DOCS. 137 Using the DAF . 192 CHANGE_PASSWORD . 138 CLEAR_FIELDS . 138 Chapter 14. Modifying client behavior CLOSE_ALL_DOCS . 139 CLOSE_ALL_FOLDERS . 139 through the Registry . 193 CLOSE_DOC . 140 CLOSE_FOLDER . 140 Chapter 15. Integration with Monarch COPY_DOC_PAGES . 141 Version 5 . 195 DELETE_DOC . 142 Before you begin . 196 DESELECT_DOC . 143 Configuring the client . 196 DISABLE_SWITCH . 143 Adding the Registry key . 196 ENABLE_SWITCH . 144 Exporting the Registry key . 201 EXIT . 145 iv Windows Client Customization Guide Using multiple Monarch model files. 201 Steps for mapping fonts . 218 Configuring Setup. 202 Syntax rules for font definition files . 219 Copying client software . 203 Coded Font file. 219 Adding subdirectories . 203 Coded Font file rules . 220 Copying Monarch files . 203 Character Set Definition file . 220 Sharing the installation directory . 203 Character Set Definition file rules. 222 Running Setup . 204 Code Page Definition file . 223 Running Monarch from OnDemand . 204 Code Page Definition file rules . 223 Upgrading your OnDemand client . 204 Code Page Map files . 224 Code Page Map file rules . 224 Chapter 16. Installing client software Code Page Map file REXX program for building on a network . 205 a Code Page Map file . 224 Setting up to build a Code Page Map file . 225 Sharing OnDemand clients among multiple users 205 Alias file . 226 Installation directories . 206 Alias File Rules. 227 Distribution install . 206 Support for TrueType fonts . 227 Overview. 206 TrueType Fonts . 228 Copying OnDemand software to the server . 207 Distributing user-defined files . 207 Multiple user install . 207 | Chapter 20. Troubleshooting . 229 Overview. 207 | Troubleshooting scenario 1: StoreDoc() API returns Installing Adobe software . 207 | error code 2 . 229 Installing the OnDemand client on the server 208 | Hints and tips . 229 Sharing user-defined files . 208 | Tip 1: How to allow a user to print AFP files Node install . 208 | without opening them with the workbench or Overview. 208 | navigation plug-in. 229 Installing Adobe software . 209 Installing the client . 209 Appendix A. Microsoft Visual Basic 5.0 DDE sample program . 231 Chapter 17. Distributing user-defined Global variables used by the sample program . 231 files . .211 Entry point for the sample program . 232 Overview. .211 Copying OnDemand client software to the server 212 Appendix B. Microsoft Visual C++ 5.0 Adding subdirectories . 212 DDE sample program . 245 Storing user-defined files on the server . 213 Installing the OnDemand client . 213 Appendix C. Microsoft Visual Basic 5.0 OLE sample program . 255 Chapter 18. Using response files . 215.