RemoteWare API Manual Version 4.1 Service Pack 1A RemoteWare API Manual Version 4.1 Service Pack 1A This document was prepared to assist licensed users of RemoteWare by XcelleNet, Inc.; its contents may not be used for any other purpose without prior written permission. The material contained herein is supplied without representation or warranty of any kind and is based on typical use. Any unusual use may produce unpredictable results. XCELLENET ASSUMES NO RESPONSIBILITY AND SHALL HAVE NO LIABILITY OF ANY KIND ARISING FROM THE SUPPLY OR USE OF THIS DOCUMENT OR THE MATERIAL CONTAINED HEREIN. Companies, names, information, and data used in examples herein are fictitious unless otherwise noted. The information in this document is furnished for informational use only and is subject to change without notice. References in this manual to XcelleNet products, programs, or services do not imply that XcelleNet intends to make these available in all countries in which XcelleNet operates. Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in FAR 52.227-19. © 1997- 2003 XcelleNet, Inc. All Rights Reserved. All rights reserved, including the right to reproduce this document or any portion thereof in any form. Printed in the United States of America. RemoteWare is a trademark of XcelleNet, Inc. Other product and company names mentioned herein may be the brand names, trade names, trademarks or registered trade- marks of their respective orders. Contents USING THIS GUIDE About this guide ............................................................................................................... vii Working with an electronic guide.................................................................................... vii Using bookmarks and links......................................................................................... viii Using the Find feature ................................................................................................. ix Printing this guide.......................................................................................................... x Using RemoteWare online Help ...................................................................................... xi RemoteWare Support Services........................................................................................ xii What’s in this guide ......................................................................................................... xiii Related publications........................................................................................................ xiv Additional information sources .................................................................................. xvi CHAPTER 1: INSTALLING API FILES Supported environments ................................................................................................. 18 Supported compilers........................................................................................................ 19 Installing the API files from the CD-ROM .................................................................... 20 Copying API files ......................................................................................................... 20 Testing your API programs.............................................................................................. 21 Using the APIs with Visual Basic..................................................................................... 21 CHAPTER 2: USING THE API FUNCTIONS Error handling.................................................................................................................. 24 Types of errors ............................................................................................................. 24 Interpreting data types..................................................................................................... 26 CHAPTER 3: SERVER API FUNCTIONS General notes ................................................................................................................... 28 New functions .................................................................................................................. 28 Building Server applications............................................................................................ 29 Error codes....................................................................................................................... 30 Server Alarm API functions............................................................................................. 31 Server worklist API functions .......................................................................................... 35 Server Notify API functions............................................................................................. 51 iv RemoteWare API Manual Server database API functions......................................................................................... 56 Server Object API functions............................................................................................ 76 Server Schedule API function ....................................................................................... 101 Server Information API function................................................................................... 104 Server Reset Security API function............................................................................... 107 CHAPTER 4: 16-BIT WINDOWS AND 32-BIT OS/2 CLIENT APIS General notes ................................................................................................................. 110 Compiling and linking applications for Windows ......................................................... 110 Compiling and linking applications for OS/2 ................................................................ 111 Error codes..................................................................................................................... 112 Client Configuration and Status API functions ............................................................ 112 Transaction Pipe API functions ..................................................................................... 132 Transaction Pipe Notification Types ......................................................................... 133 Transaction Pipe Error Codes................................................................................... 133 Client Worklist API functions........................................................................................ 141 Client Dialing Directory API functions ........................................................................ 153 Client Object API functions .......................................................................................... 154 CHAPTER 5: DOS CLIENT APIS General notes ................................................................................................................. 164 Compiling and linking applications ............................................................................... 164 Error codes..................................................................................................................... 165 DOS Client Configuration and Status API functions.................................................. 165 CHAPTER 6: WORKLIST EVENTS Using worklists ............................................................................................................... 176 Client vs. Server worklist APIs.................................................................................. 176 Communicating between worklists and programs ................................................... 176 Worklist default files and paths...................................................................................... 179 File transfer events......................................................................................................... 180 Operating system events ................................................................................................ 189 Session control events .................................................................................................... 212 Server events .................................................................................................................. 229 CHAPTER 7: WIN32 COM OBJECT CLIENT APIS Contents v Overview of Win32 COM OBJECT Client APIs.......................................................... 237 Interface Definition Language (IDL)........................................................................... 237 Error handling................................................................................................................ 238 Win32 Client API structure........................................................................................... 240 RWClient Object ....................................................................................................... 240 EnumRWClientInfo Object...................................................................................... 240 XWorkList Object ...................................................................................................... 240 RWClientInfo Object ................................................................................................ 240 RWClientDialingEntry Object.................................................................................. 241 IRWClientDialingEntryCollection Object ..............................................................