source: cprs/branches/GUI-config/BDK32/Help/broker.toc@ 1328

Last change on this file since 1328 was 476, checked in by Kevin Toppenberg, 16 years ago

New WorldVistA Config Utility

File size: 5.9 KB
Line 
1:Base broker.hlp>main
2:Title RPC Broker Developer's Guide
3
41 RPC Broker V. 1.1 Developer's Guide
52 Overview
63 Introduction=introduction
73 Broker Overview=Broker_Overview
83 Orientation=Orientation
93 About this Version of the RPC Broker=About_this_version
103 What's New in the BDK=Whats_New_in_the_BDK
113 Developer Considerations=Developer_Considerations
123 Application Issues=Application_Level_Issues
133 Silent Login=Silent_Login
143 Context-sensitive Help for the TRPCBroker Component=ig_helpfile
152 RPC Broker Components and Classes
163 TCCOWRPCBroker=TCCOWRPCBroker_Component
173 TRPCBroker Component=TRPCBroker
183 TSharedRPCBroker Component=TSharedRPCBroker_Component
193 TXWBRichEdit Component=TXWBRichEdit_Component
203 TMult Class=TMult_Class
213 TParamRecord Class=TParamRecord_Class
223 TParams Class=TParams_Class
233 TVistaLogin Class=TVistaLogin_Class
243 TVistaUser Class=TVistaUser_Class
253 EBrokerError Exception=EBrokerError
263 Units
274 Hash Unit=Hash_unit
284 LoginFrm Unit=LoginFrm_Unit
294 MFunStr Unit=MFunStr_unit
304 RPCConf1 Unit=RPCConf1_unit
314 RpcSLogin Unit=RpcSLogin_Unit
324 SplVista Unit=SplVista_unit
334 TCCOWRPCBroker Unit=TCCOWRPRCBroker_unit
344 TRPCB Unit=TRPCB_unit
354 TVCEdit Unit=TVCEdit_Unit
362 Remote Procedure Calls (RPCs)
373 Overview=rpc_overview
383 What Makes a Good RPC?=rpc_good
393 Creating RPCs=rpc_create
403 Using an Existing M API=Using_an_Existing_M_API
413 M Entry Point for an RPC
424 Relationship Between an M Entry Point and an RPC=rpc_routine_relationship
434 First Input Parameter=rpc_first_input_param
444 Return Value Types=rpc_return_value_types
454 Input Parameters=rpc_input_parameter_types
464 Examples=rpc_entry_point_examples
473 RPC Entry in the Remote Procedure File
484 RPC Entry in the Remote Procedure File=rpc_file_entry
494 RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File
504 Blocking an RPC in the Remote Procedure File=Blocking_an_RPC
514 Cleanup after RPC Execution=rpc_cleanup
524 Documenting RPCs=rpc_document
533 Executing RPCs from Clients
544 How to Execute an RPC from a Client=rpc_execute_from_client
554 RPC Security: How to Register an RPC=rpc_register
564 RPC Limits=RPC_limits
574 BrokerExample Online Code Example=BrokerExample
582 Other RPC Broker APIs
593 Overview=otherapi_Overview
603 Encryption Functions=otherapi_encrypt
613 GetServerInfo Function=otherapi_getserverinfo
623 M Emulation Functions=otherapi_m_emulation
633 VistA Splash Screen Procedures=otherapi_splash
643 $$BROKER^XWBLIB=otherapi_broker
653 $$RTRNFMT^XWBLIB=otherapi_rtrnfmt
663 XWB ARE RPCS AVAILABLE=XWB_ARE_RPCS_AVAILABLE
673 XWB IS RPC AVAILABLE=XWB_IS_RPC_AVAILABLE
683 XWB GET VARIABLE VALUE RPC=otherapi_getvarvalue
693 Running RPCs on a Remote Server
704 Options For Running RPCs on a Remote Server=Options_For_Running_RPCs_on_a_Remote_Server
714 Checking RPC Availability on a Remote Server=Checking_RPC_Availability_on_a_Remote_Server
724 XWB DIRECT RPC=XWB_DIRECT_RPC
734 XWB REMOTE RPC=XWB_REMOTE_RPC
744 XWB REMOTE STATUS CHECK=XWB_REMOTE_STATUS_CHECK
754 XWB REMOTE GETDATA=XWB_REMOTE_GETDATA
764 XWB REMOTE CLEAR=XWB_REMOTE_CLEAR
773 Deferred RPCs
784 Overview of Deferred RPCs=Overview_of_Deferred_RPCs
794 XWB DEFERRED RPC=XWB_DEFERRED_RPC
804 XWB DEFERRED STATUS=XWB_DEFERRED_STATUS
814 XWB DEFERRED GETDATA=XWB_DEFERRED_GETDATA
824 XWB DEFERRED CLEAR=XWB_DEFERRED_CLEAR
834 XWB DEFERRED CLEARALL=XWB_DEFERRED_CLEARALL
842 Debugging and Troubleshooting
853 Overview=debug_overview
863 How to Debug Your Application=debug
873 RPC Error Trapping=Error_Handling
883 Identifying the Listener Process on the Server=ID_Listener
893 Identifying the Handler Process on the Server=ID_Handler
903 Testing Your RPC Broker Connection=Testing_Connection
913 Client Timeout and Buffer Clearing=Buffer_Clearing
923 Memory Leaks=memory_leaks
932 Developer Utilities
943 RPC Broker Programmer Preferences=IDH_brokprogpref
952 Tutorial
963 Introduction=tut_intro
973 Advanced Preparation=tut_prep
983 Step 1: Create Application with an RPC Broker Component=tut_step1
993 Step 2: Get Server/Port=tut_step2
1003 Step 3: Establish Broker Connection=tut_step3
1013 Step 4: RPC Routine to List Terminal Types=tut_step4
1023 Step 5: RPC to List Terminal Types=tut_step5
1033 Step 6: Call the ZxxxTT LIST RPC=tut_step6
1043 Step 7: Associate IENs=tut_step7
1053 Step 8: Routine to Retrieve Terminal Types=tut_step8
1063 Step 9: RPC to Retrieve Terminal Types=tut_step9
1073 Step 10: Call Zxxx RETRIEVE RPC=tut_step10
1083 Step 11: Register RPCs=tut_register
1093 See Also: FileMan Delphi Components (FMDC)=tut_fmdc
1103 Tutorial Source Code=tut_pascal
1112 DLL Interface
1123 Introduction=dll_intro
1133 DLL Special Issues
1144 RPC Results from DLL Calls=dll_results
1154 GetServerInfo Function and the DLL=dll_getserverinfo
1163 DLL Exported Functions
1174 RPCBCall=dll_function_rpcbcall
1184 RPCBCreate=dll_function_rpcbcreate
1194 RPCBCreateContext=dll_function_rpcbcreatecontext
1204 RPCBFree=dll_function_rpcbfree
1214 RPCBMultItemGet=dll_function_rpcbmultitemget
1224 RPCBMultPropGet=dll_function_rpcbmultpropget
1234 RPCBMultSet=dll_function_rpcbmultset
1244 RPCBMultSortedSet=dll_function_rpcbmultsortedset
1254 RPCBParamGet=dll_function_rpcbParamGet
1264 RPCBParamSet=dll_function_rpcbParamSet
1274 RPCBPropGet=dll_function_rpcbpropget
1284 RPCBPropSet=dll_function_rpcbpropset
1293 Guidelines for C++
1304 Overview=dll_cpp_intro
1314 TRPCBroker C++ Class Methods=dll_cpp_methods
1324 Initialize the Class=dll_cpp_init
1334 Create Broker Instances=dll_cpp_create
1344 Connect to the Server=dll_cpp_connect
1354 Execute RPCs=dll_cpp_execute
1364 Destroy Broker Instances=dll_cpp_destroy
1373 Guidelines for C
1384 Overview=dll_c_intro
1394 Initialize—LoadLibrary and GetProcAddress=dll_c_init
1404 Create Broker Components=dll_c_create
1414 Connect to the Server=dll_c_connect
1424 Execute RPCs=dll_c_execute
1434 Destroy Broker Components=dll_c_destroy
1443 Guidelines for Visual Basic
1454 Overview=dll_vb_intro
1464 Initialize=dll_vb_init
1474 Create Broker Components=dll_vb_create
1484 Connect to the Server=dll_vb_connect
1494 Execute RPCs=dll_vb_execute
1504 Destroy Broker Components=dll_vb_destroy
Note: See TracBrowser for help on using the repository browser.