Difference between revisions of "Broker help/TOC"
From VistApedia
DavidWhitten (talk | contribs) |
DavidWhitten (talk | contribs) |
||
| Line 92: | Line 92: | ||
==[[Broker_help\2 Developer Utilities]] == | ==[[Broker_help\2 Developer Utilities]] == | ||
===[[Broker_help\3 RPC Broker Programmer Preferences=IDH_brokprogpref]] === | ===[[Broker_help\3 RPC Broker Programmer Preferences=IDH_brokprogpref]] === | ||
| − | == | + | == Tutorial == |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_intro| Introduction]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_prep| Advanced Preparation]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step1|Step 1: Create Application with an RPC Broker Component]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step2|Step 2: Get Server/Port]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step3|Step 3: Establish Broker Connection]] ==== |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step4|Step 4: RPC Routine to List Terminal Types]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step5|Step 5: RPC to List Terminal Types]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step6|Step 6: Call the ZxxxTT LIST RPC]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step7|Step 7: Associate IENs]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step8|Step 8: Routine to Retrieve Terminal Types]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step9|Step 9: RPC to Retrieve Terminal Types]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_step10|Step 10: Call Zxxx RETRIEVE RPC]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_register| Step 11: Register RPCs]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_fmdc|See Also: FileMan Delphi Components (FMDC)]] === |
| − | ===[[Broker_help\ | + | ===[[Broker_help\tut_pascal|Tutorial Source Code]] === |
| − | == | + | == DLL Interface == |
| − | ===[[Broker_help\ | + | ===[[Broker_help\dll_intro| Introduction]] === |
| − | == | + | == DLL Special Issues === |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_results|RPC Results from DLL Calls]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_getserverinfo|GetServerInfo Function and the DLL]] ==== |
| − | === | + | === DLL Exported Functions === |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbcall|RPCBCall]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbcreate|RPCBCreate]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbcreatecontext|RPCBCreateContext]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbfree|RPCBFree]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbmultitemget|RPCBMultItemGet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbmultpropget|RPCBMultPropGet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbmultset|RPCBMultSet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbmultsortedset|RPCBMultSortedSet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbParamGet|RPCBParamGet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbParamSet|RPCBParamSet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbpropget|RPCBPropGet]] ==== |
| − | ====[[Broker_help\ | + | ====[[Broker_help\dll_function_rpcbpropset|RPCBPropSet]] ==== |
=== Guidelines for C++ === | === Guidelines for C++ === | ||
====[[Broker_help\dll_cpp_intro|Overview]] ==== | ====[[Broker_help\dll_cpp_intro|Overview]] ==== | ||
Revision as of 22:14, 20 December 2010
This is a conversion of the Broker.hlp file to mediawiki format using the helpdeco converter program converted to vistapedia.net by Ignacio Valdes of Astronaut, LLC The original formatting such as Table of Contents linking and screen shots is not present.
- Base broker.hlp>main
- Title RPC Broker Developer's Guide
Contents
- 1 RPC Broker V. 1.1 Developer's Guide
- 1.1 Overview
- 1.2 RPC Broker Components and Classes
- 1.2.1 TRPCBroker Component
- 1.2.2 TXWBRichEdit Component
- 1.2.3 TMult Class
- 1.2.4 TParamRecord Class
- 1.2.5 TParams Class
- 1.2.6 TVistaLogin Class
- 1.2.7 TVistaUser Class
- 1.2.8 Broker_help\3 EBrokerError Exception=EBrokerError
- 1.2.9 Units
- 1.2.9.1 Broker_help\4 Hash Unit=Hash_unit
- 1.2.9.2 Broker_help\4 LoginFrm Unit=LoginFrm_Unit
- 1.2.9.3 Broker_help\4 MFunStr Unit=MFunStr_unit
- 1.2.9.4 Broker_help\4 RPCConf1 Unit=RPCConf1_unit
- 1.2.9.5 Broker_help\4 RpcSLogin Unit=RpcSLogin_Unit
- 1.2.9.6 Broker_help\4 SplVista Unit=SplVista_unit
- 1.2.9.7 Broker_help\4 TRPCB Unit=TRPCB_unit
- 1.2.9.8 Broker_help\4 TVCEdit Unit=TVCEdit_Unit
- 1.3 Broker_help\2 Remote Procedure Calls (RPCs)
- 1.3.1 Broker_help\3 Overview=rpc_overview
- 1.3.2 Broker_help\3 What Makes a Good RPC?=rpc_good
- 1.3.3 Broker_help\3 Creating RPCs=rpc_create
- 1.3.4 Broker_help\3 M Entry Point for an RPC
- 1.3.4.1 Broker_help\4 Relationship Between an M Entry Point and an RPC=rpc_routine_relationship
- 1.3.4.2 Broker_help\4 First Input Parameter=rpc_first_input_param
- 1.3.4.3 Broker_help\4 Return Value Types=rpc_return_value_types
- 1.3.4.4 Broker_help\4 Input Parameters=rpc_input_parameter_types
- 1.3.4.5 Broker_help\4 Examples=rpc_entry_point_examples
- 1.3.5 Broker_help\3 RPC Entry in the Remote Procedure File
- 1.3.5.1 Broker_help\4 RPC Entry in the Remote Procedure File=rpc_file_entry
- 1.3.5.2 Broker_help\4 RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File
- 1.3.5.3 Broker_help\4 Blocking an RPC in the Remote Procedure File=Blocking_an_RPC
- 1.3.5.4 Broker_help\4 Cleanup after RPC Execution=rpc_cleanup
- 1.3.5.5 Broker_help\4 Documenting RPCs=rpc_document
- 1.3.6 Broker_help\3 Executing RPCs from Clients =
- 1.4 Broker_help\2 Other RPC Broker APIs
- 1.4.1 Broker_help\3 Overview=otherapi_Overview
- 1.4.2 Broker_help\3 Encryption Functions=otherapi_encrypt
- 1.4.3 Broker_help\3 GetServerInfo Function=otherapi_getserverinfo
- 1.4.4 Broker_help\3 M Emulation Functions=otherapi_m_emulation
- 1.4.5 Broker_help\3 VistA Splash Screen Procedures=otherapi_splash =
- 1.4.6 Broker_help\3 $$BROKER^XWBLIB=otherapi_broker
- 1.4.7 Broker_help\3 $$RTRNFMT^XWBLIB=otherapi_rtrnfmt
- 1.4.8 Broker_help\3 XWB ARE RPCS AVAILABLE=XWB_ARE_RPCS_AVAILABLE
- 1.4.9 Broker_help\3 XWB IS RPC AVAILABLE=XWB_IS_RPC_AVAILABLE
- 1.4.10 Broker_help\3 XWB GET VARIABLE VALUE RPC=otherapi_getvarvalue
- 1.4.11 Broker_help\3 Running RPCs on a Remote Server
- 1.4.11.1 Broker_help\4 Options For Running RPCs on a Remote Server=Options_For_Running_RPCs_on_a_Remote_Server
- 1.4.11.2 Broker_help\4 Checking RPC Availability on a Remote Server=Checking_RPC_Availability_on_a_Remote_Server
- 1.4.11.3 Broker_help\4 XWB DIRECT RPC=XWB_DIRECT_RPC
- 1.4.11.4 Broker_help\4 XWB REMOTE RPC=XWB_REMOTE_RPC
- 1.4.11.5 Broker_help\4 XWB REMOTE STATUS CHECK=XWB_REMOTE_STATUS_CHECK
- 1.4.11.6 Broker_help\4 XWB REMOTE GETDATA=XWB_REMOTE_GETDATA
- 1.4.11.7 Broker_help\4 XWB REMOTE CLEAR=XWB_REMOTE_CLEAR
- 1.4.12 =Broker_help\3 Deferred RPCs
- 1.4.12.1 Broker_help\4 Overview of Deferred RPCs=Overview_of_Deferred_RPCs
- 1.4.12.2 Broker_help\4 XWB DEFERRED RPC=XWB_DEFERRED_RPC
- 1.4.12.3 Broker_help\4 XWB DEFERRED STATUS=XWB_DEFERRED_STATUS
- 1.4.12.4 Broker_help\4 XWB DEFERRED GETDATA=XWB_DEFERRED_GETDATA
- 1.4.12.5 Broker_help\4 XWB DEFERRED CLEAR=XWB_DEFERRED_CLEAR
- 1.4.12.6 Broker_help\4 XWB DEFERRED CLEARALL=XWB_DEFERRED_CLEARALL
- 1.5 Broker_help\2 Debugging and Troubleshooting
- 1.5.1 Broker_help\3 Overview=debug_overview
- 1.5.2 Broker_help\3 How to Debug Your Application=debug
- 1.5.3 Broker_help\3 RPC Error Trapping=Error_Handling
- 1.5.4 Broker_help\3 Identifying the Listener Process on the Server=ID_Listener
- 1.5.5 Broker_help\3 Identifying the Handler Process on the Server=ID_Handler
- 1.5.6 Broker_help\3 Testing Your RPC Broker Connection=Testing_Connection
- 1.5.7 Broker_help\3 Client Timeout and Buffer Clearing=Buffer_Clearing
- 1.5.8 Broker_help\3 Memory Leaks=memory_leaks
- 1.6 Broker_help\2 Developer Utilities
- 1.7 Tutorial
- 1.7.1 Introduction
- 1.7.2 Advanced Preparation
- 1.7.3 Step 1: Create Application with an RPC Broker Component
- 1.7.4 Step 2: Get Server/Port
- 1.7.5 Step 3: Establish Broker Connection =
- 1.7.6 Step 4: RPC Routine to List Terminal Types
- 1.7.7 Step 5: RPC to List Terminal Types
- 1.7.8 Step 6: Call the ZxxxTT LIST RPC
- 1.7.9 Step 7: Associate IENs
- 1.7.10 Step 8: Routine to Retrieve Terminal Types
- 1.7.11 Step 9: RPC to Retrieve Terminal Types
- 1.7.12 Step 10: Call Zxxx RETRIEVE RPC
- 1.7.13 Step 11: Register RPCs
- 1.7.14 See Also: FileMan Delphi Components (FMDC)
- 1.7.15 Tutorial Source Code
- 1.8 DLL Interface
- 1.9 DLL Special Issues =
RPC Broker V. 1.1 Developer's Guide
Overview
Introduction
Broker Overview
Orientation
About this Version of the RPC Broker
What's New in the BDK
Developer Considerations
Application Issues
Silent Login
Context-sensitive Help for the TRPCBroker Component
RPC Broker Components and Classes
TRPCBroker Component
TXWBRichEdit Component
TMult Class
TParamRecord Class
TParams Class
TVistaLogin Class
TVistaUser Class
Broker_help\3 EBrokerError Exception=EBrokerError
Units
Broker_help\4 Hash Unit=Hash_unit
Broker_help\4 LoginFrm Unit=LoginFrm_Unit
Broker_help\4 MFunStr Unit=MFunStr_unit
Broker_help\4 RPCConf1 Unit=RPCConf1_unit
Broker_help\4 RpcSLogin Unit=RpcSLogin_Unit
Broker_help\4 SplVista Unit=SplVista_unit
Broker_help\4 TRPCB Unit=TRPCB_unit
Broker_help\4 TVCEdit Unit=TVCEdit_Unit
Broker_help\2 Remote Procedure Calls (RPCs)
Broker_help\3 Overview=rpc_overview
Broker_help\3 What Makes a Good RPC?=rpc_good
Broker_help\3 Creating RPCs=rpc_create
===[[Broker_help\3 Using an Existing M API=Using_an_Existing_M_API
