Difference between revisions of "Broker help/TOC"
From VistApedia
DavidWhitten (talk | contribs) |
DavidWhitten (talk | contribs) (→Orientation) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | 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. | + | : 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 | :Base broker.hlp>main | ||
:Title RPC Broker Developer's Guide | :Title RPC Broker Developer's Guide | ||
| − | + | RPC Broker V. 1.1 Developer's Guide | |
| − | = | + | = Overview = |
| − | == | + | == Introduction == |
| − | + | The RPC Broker is a client/server system within VA's Veterans Health Information Systems and Technology Architecture (VISTA) environment. It enables client applications to communicate and exchange data with M Servers. | |
| − | + | ||
| − | + | This manual describes the development features of the RPC Broker. The emphasis is on using the RPC Broker in conjunction with Borland's Delphi software. However, the RPC Broker supports other development environments. | |
| − | + | ||
| − | + | This manual provides a complete reference for development with the RPC Broker. For an overview of development with the RPC Broker component, see the "RPC Broker V. 1.1 Getting Started with the Broker Development Kit" manual. | |
| − | + | ||
| − | + | This document is intended for the VISTA development community and Information Resource Management (IRM) staff. A wider audience of technical personnel engaged in operating and maintaining the Department of Veterans Affairs (VA) software might also find it useful as a reference. | |
| − | + | ||
| − | + | ==[[Broker_help/Broker_Overview|Broker Overview]] == | |
| − | + | ||
| − | + | For the latest RPC Broker product information, please refer to the RPC Broker Home Page on the web at: | |
| − | + | http://vista.med.va.gov/broker/index.html. | |
| − | + | ||
| − | + | ||
| − | + | ==[[Broker_help/Orientation|Orientation]] == | |
| − | + | ||
| − | + | ==[[Broker_help/About_this_version| About this Version of the RPC Broker]] == | |
| − | + | This version of the Broker provides programmers with the capability to develop new VISTA client/server software using the Broker Delphi component (i.e., TRPCBroker) in the 32-bit environment. | |
| − | + | ==[[Broker_help/Whats_New_in_the_BDK| What's New in the BDK]] == | |
| − | + | What’s New Through May 2002? | |
| − | + | ||
| − | + | Support for Delphi V. 6.0 | |
| − | ====[[Broker_help\ | + | |
| − | + | As of Patch XWB*1.1*13, the BDK supports Delphi V. 6.0. | |
| − | + | ||
| − | + | ||
| − | ==[[Broker_help\ | + | ==[[Broker_help/Developer_Considerations| Developer Considerations]] == |
| − | ===[[Broker_help\ | + | ==[[Broker_help/Application_Level_Issues| Application Issues]] == |
| − | ===[[Broker_help\ | + | ==[[Broker_help/Silent_Login|Silent Login]] == |
| − | ===[[Broker_help\ | + | ==[[Broker_help/ig_helpfile|Context-sensitive Help for the TRPCBroker Component]] == |
| − | ===[[Broker_help\ | + | = RPC Broker Components and Classes = |
| − | ===[[Broker_help\ | + | ==[[Broker_help\TRPCBroker|TRPCBroker Component]] == |
| − | + | New TRPCBroker Component Properties | |
| − | + | ||
| − | + | As of Patch XWB*1.1*13, the following properties are new with this version of the RPC Broker: | |
| − | + | ||
| − | + | * Property | |
| − | ===[[Broker_help\ | + | * CurrentContext (Public) |
| − | + | * KerneLogIn (Published) | |
| − | + | * LogIn (Public) | |
| − | == | + | * OnRPCBFailure (Public) |
| − | + | * RPCBError (Public) | |
| − | + | * ShowErrorMsgs (Published) | |
| − | ===[[Broker_help\ | + | * User (Public) |
| − | + | ||
| − | + | ==[[Broker_help\TXWBRichEdit_Component|TXWBRichEdit Component]] == | |
| − | ====[[Broker_help\ | + | ==[[Broker_help\TMult_Class|TMult Class]] == |
| − | + | ==[[Broker_help\TParamRecord_Class|TParamRecord Class]] == | |
| − | ==[[Broker_help\ | + | ==[[Broker_help\TParams_Class| TParams Class]] == |
| − | ===[[Broker_help\ | + | ==[[Broker_help\TVistaLogin_Class| TVistaLogin Class]]== |
| − | ===[[Broker_help\ | + | ==[[Broker_help\TVistaUser_Class| TVistaUser Class]] == |
| − | + | ==[[Broker_help\EBrokerError|EBrokerError Exception]]== | |
| − | + | ==[[Broker_help\Units|Units]] == | |
| − | + | ===[[Broker_help\Hash_unit|Hash Unit]] === | |
| − | + | ===[[Broker_help\LoginFrm_Unit|LoginFrm Unit]] === | |
| − | + | ===[[Broker_help\MFunStr_unit|MFunStr Unit]] === | |
| − | + | ===[[Broker_help\RPCConf1_unit|RPCConf1 Unit]] === | |
| − | + | ===[[Broker_help\RpcSLogin_Unit|RpcSLogin Unit]] === | |
| − | + | ===[[Broker_help\SplVista_unit|SplVista Unit]] === | |
| − | == | + | ===[[Broker_help\TRPCB_unit|TRPCB Unit]] === |
| − | + | ===[[Broker_help\TVCEdit_Unit|TVCEdit Unit]] === | |
| − | + | = Remote Procedure Calls (RPCs) = | |
| − | + | ==[[Broker_help\rpc_overview|Overview]] == | |
| − | + | ==[[Broker_help\rpc_good|What Makes a Good RPC?]] == | |
| − | + | ==[[Broker_help\rpc_create|Creating RPCs]] == | |
| − | + | ==[[Broker_help\Using_an_Existing_M_API|Using an Existing M API]] == | |
| − | + | ==M Entry Point for an RPC == | |
| − | == | + | ===[[Broker_help\=rpc_routine_relationship|Relationship Between an M Entry Point and an RPC]] === |
| − | + | ===[[Broker_help\rpc_first_input_param|First Input Parameter]] === | |
| − | + | ===[[Broker_help\rpc_return_value_types|Return Value Types]] === | |
| − | + | ===[[Broker_help\rpc_input_parameter_types|Input Parameters]]=== | |
| − | + | ===[[Broker_help\rpc_entry_point_examples|Examples]] === | |
| − | + | == RPC Entry in the Remote Procedure File == | |
| − | + | ===[[Broker_help\rpc_file_entry|RPC Entry in the Remote Procedure File]] === | |
| − | = | + | ===[[Broker_help\RPC_Version_in_Remote_Procedure_File|RPC Version in the Remote Procedure File]] === |
| − | + | ===[[Broker_help\Blocking_an_RPC|Blocking an RPC in the Remote Procedure File]] === | |
| − | + | ===[[Broker_help\rpc_cleanup|Cleanup after RPC Execution]] === | |
| − | + | ===[[Broker_help\rpc_document|Documenting RPCs]] === | |
| − | + | == Executing RPCs from Clients == | |
| − | + | ===[[Broker_help\rpc_execute_from_client|How to Execute an RPC from a Client]] === | |
| − | + | ===[[Broker_help\rpc_register|RPC Security: How to Register an RPC]] === | |
| − | + | ===[[Broker_help\RPC_limits|RPC Limits]] === | |
| − | + | ===[[Broker_help\BrokerExample|BrokerExample Online Code Example]] === | |
| − | = | + | = Other RPC Broker APIs = |
| − | + | ==[[Broker_help\otherapi_Overview|Overview]] == | |
| − | + | ==[[Broker_help\otherapi_encrypt|Encryption Functions]] == | |
| − | + | ==[[Broker_help\otherapi_getserverinfo|GetServerInfo Function]] == | |
| − | + | ==[[Broker_help\otherapi_m_emulation|M Emulation Functions]] == | |
| − | + | ==[[Broker_help\otherapi_splash|VistA Splash Screen Procedures]] == | |
| − | + | ==[[Broker_help\otherapi_broker|$$BROKER^XWBLIB]] == | |
| − | + | ==[[Broker_help\otherapi_rtrnfmt|$$RTRNFMT^XWBLIB]] == | |
| − | + | ==[[Broker_help\XWB_ARE_RPCS_AVAILABLE|XWB ARE RPCS AVAILABLE]]== | |
| − | + | ==[[Broker_help\XWB_IS_RPC_AVAILABLE|XWB IS RPC AVAILABLE]] == | |
| − | + | ==[[Broker_help\otherapi_getvarvalue|XWB GET VARIABLE VALUE RPC]] == | |
| − | + | == Running RPCs on a Remote Server == | |
| − | + | ===[[Broker_help\Options_For_Running_RPCs_on_a_Remote_Server|Options For Running RPCs on a Remote Server]] === | |
| − | + | ===[[Broker_help\=Checking_RPC_Availability_on_a_Remote_Server| Checking RPC Availability on a Remote Server]] === | |
| − | + | ===[[Broker_help\XWB_DIRECT_RPC|XWB DIRECT RPC]] === | |
| − | + | ===[[Broker_help\XWB_REMOTE_RPC|XWB REMOTE RPC]] === | |
| − | + | ===[[Broker_help\XWB_REMOTE_STATUS_CHECK|XWB REMOTE STATUS CHECK]] === | |
| − | + | ===[[Broker_help\XWB_REMOTE_GETDATA|XWB REMOTE GETDATA]] === | |
| − | + | ===[[Broker_help\XWB_REMOTE_CLEAR|XWB REMOTE CLEAR]]=== | |
| − | + | == Deferred RPCs == | |
| − | == DLL Special Issues | + | ===[[Broker_help\Overview_of_Deferred_RPCs|Overview of Deferred RPCs]] === |
| − | + | ===[[Broker_help\XWB_DEFERRED_RPC|XWB DEFERRED RPC]] === | |
| − | + | ===[[Broker_help\XWB_DEFERRED_STATUS|XWB DEFERRED STATUS]] === | |
| − | + | ===[[Broker_help\XWB_DEFERRED_GETDATA|XWB DEFERRED GETDATA]] === | |
| − | + | ===[[Broker_help\XWB_DEFERRED_CLEAR|XWB DEFERRED CLEAR]] === | |
| − | + | ===[[Broker_help\XWB_DEFERRED_CLEARALL|XWB DEFERRED CLEARALL]] === | |
| − | + | = Debugging and Troubleshooting = | |
| − | + | ==[[Broker_help\debug_overview| Overview]] == | |
| − | + | ==[[Broker_help\debug|How to Debug Your Application]] == | |
| − | + | ==[[Broker_help\Error_Handling| RPC Error Trapping]] == | |
| − | + | ==[[Broker_help\ID_Listener|Identifying the Listener Process on the Server]] == | |
| − | + | ==[[Broker_help\ID_Handler|Identifying the Handler Process on the Server]] == | |
| − | + | ==[[Broker_help\Testing_Connection|Testing Your RPC Broker Connection]] == | |
| − | + | ==[[Broker_help\Buffer_Clearing|Client Timeout and Buffer Clearing]] == | |
| − | + | ==[[Broker_help\memory_leaks|Memory Leaks]] == | |
| − | + | = Developer Utilities = | |
| − | + | ==[[Broker_help\IDH_brokprogpref|RPC Broker Programmer Preferences]] == | |
| − | + | = Tutorial = | |
| − | + | ==[[Broker_help\tut_intro| Introduction]] == | |
| − | + | ==[[Broker_help\tut_prep| Advanced Preparation]] == | |
| − | + | ==[[Broker_help\tut_step1|Step 1: Create Application with an RPC Broker Component]] == | |
| − | + | ==[[Broker_help\tut_step2|Step 2: Get Server/Port]] == | |
| − | + | ==[[Broker_help\tut_step3|Step 3: Establish Broker Connection]] == | |
| − | + | ==[[Broker_help\tut_step4|Step 4: RPC Routine to List Terminal Types]] == | |
| − | + | ==[[Broker_help\tut_step5|Step 5: RPC to List Terminal Types]] == | |
| − | + | ==[[Broker_help\tut_step6|Step 6: Call the ZxxxTT LIST RPC]] == | |
| − | + | ==[[Broker_help\tut_step7|Step 7: Associate IENs]] == | |
| − | + | ==[[Broker_help\tut_step8|Step 8: Routine to Retrieve Terminal Types]] === | |
| − | + | ==[[Broker_help\tut_step9|Step 9: RPC to Retrieve Terminal Types]] == | |
| − | + | ==[[Broker_help\tut_step10|Step 10: Call Zxxx RETRIEVE RPC]] == | |
| − | + | ==[[Broker_help\tut_register| Step 11: Register RPCs]] == | |
| − | + | ==[[Broker_help\tut_fmdc|See Also: FileMan Delphi Components (FMDC)]] == | |
| − | + | ==[[Broker_help\tut_pascal|Tutorial Source Code]] == | |
| − | + | = DLL Interface = | |
| − | + | ==[[Broker_help\dll_intro|Introduction]] == | |
| − | + | == DLL Special Issues == | |
| − | + | ===[[Broker_help\dll_results|RPC Results from DLL Calls]] === | |
| − | + | ===[[Broker_help\dll_getserverinfo|GetServerInfo Function and the DLL]] === | |
| + | == DLL Exported Functions == | ||
| + | ===[[Broker_help\dll_function_rpcbcall|RPCBCall]] === | ||
| + | ===[[Broker_help\dll_function_rpcbcreate|RPCBCreate]] === | ||
| + | ===[[Broker_help\dll_function_rpcbcreatecontext|RPCBCreateContext]] === | ||
| + | ===[[Broker_help\dll_function_rpcbfree|RPCBFree]] === | ||
| + | ===[[Broker_help\dll_function_rpcbmultitemget|RPCBMultItemGet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbmultpropget|RPCBMultPropGet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbmultset|RPCBMultSet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbmultsortedset|RPCBMultSortedSet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbParamGet|RPCBParamGet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbParamSet|RPCBParamSet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbpropget|RPCBPropGet]] === | ||
| + | ===[[Broker_help\dll_function_rpcbpropset|RPCBPropSet]] === | ||
| + | == Guidelines for C++ == | ||
| + | ===[[Broker_help\dll_cpp_intro|Overview]] === | ||
| + | ===[[Broker_help\dll_cpp_methods|TRPCBroker C++ Class Methods]] === | ||
| + | ===[[Broker_help\dll_cpp_init|Initialize the Class]] === | ||
| + | ===[[Broker_help\dll_cpp_create|Create Broker Instances]] === | ||
| + | ===[[Broker_help\dll_cpp_connect|Connect to the Server]] === | ||
| + | ===[[Broker_help\dll_cpp_execute|Execute RPCs]] === | ||
| + | ===[[Broker_help\dll_cpp_destroy|Destroy Broker Instances]] === | ||
| + | == Guidelines for C == | ||
| + | ===[[Broker_help\dll_c_intro|Overview]] === | ||
| + | ===[[Broker_help\dll_c_init|Initialize—LoadLibrary and GetProcAddress]] === | ||
| + | ===[[Broker_help\dll_c_create|Create Broker Components]] === | ||
| + | ===[[Broker_help\dll_c_connect|Connect to the Server]] === | ||
| + | ===[[Broker_help\dll_c_execute|Execute RPCs]] === | ||
| + | ===[[Broker_help\dll_c_destroy|Destroy Broker Components]] === | ||
| + | == Guidelines for Visual Basic == | ||
| + | ===[[Broker_help\dll_vb_intro|Overview]] === | ||
| + | ===[[Broker_help\dll_vb_init|Initialize]] === | ||
| + | ===[[Broker_help\dll_vb_create|Create Broker Components]] === | ||
| + | ===[[Broker_help\dll_vb_connect|Connect to the Server]] === | ||
| + | ===[[Broker_help\dll_vb_execute|Execute RPCs]] === | ||
| + | ===[[Broker_help\dll_vb_destroy|Destroy Broker Components]] === | ||
Latest revision as of 18:41, 21 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
RPC Broker V. 1.1 Developer's Guide
Contents
- 1 Overview
- 2 RPC Broker Components and Classes
- 3 Remote Procedure Calls (RPCs)
- 4 Other RPC Broker APIs
- 4.1 Overview
- 4.2 Encryption Functions
- 4.3 GetServerInfo Function
- 4.4 M Emulation Functions
- 4.5 VistA Splash Screen Procedures
- 4.6 $$BROKER^XWBLIB
- 4.7 $$RTRNFMT^XWBLIB
- 4.8 XWB ARE RPCS AVAILABLE
- 4.9 XWB IS RPC AVAILABLE
- 4.10 XWB GET VARIABLE VALUE RPC
- 4.11 Running RPCs on a Remote Server
- 4.12 Deferred RPCs
- 5 Debugging and Troubleshooting
- 6 Developer Utilities
- 7 Tutorial
- 7.1 Introduction
- 7.2 Advanced Preparation
- 7.3 Step 1: Create Application with an RPC Broker Component
- 7.4 Step 2: Get Server/Port
- 7.5 Step 3: Establish Broker Connection
- 7.6 Step 4: RPC Routine to List Terminal Types
- 7.7 Step 5: RPC to List Terminal Types
- 7.8 Step 6: Call the ZxxxTT LIST RPC
- 7.9 Step 7: Associate IENs
- 7.10 Step 8: Routine to Retrieve Terminal Types =
- 7.11 Step 9: RPC to Retrieve Terminal Types
- 7.12 Step 10: Call Zxxx RETRIEVE RPC
- 7.13 Step 11: Register RPCs
- 7.14 See Also: FileMan Delphi Components (FMDC)
- 7.15 Tutorial Source Code
- 8 DLL Interface
Overview
Introduction
The RPC Broker is a client/server system within VA's Veterans Health Information Systems and Technology Architecture (VISTA) environment. It enables client applications to communicate and exchange data with M Servers.
This manual describes the development features of the RPC Broker. The emphasis is on using the RPC Broker in conjunction with Borland's Delphi software. However, the RPC Broker supports other development environments.
This manual provides a complete reference for development with the RPC Broker. For an overview of development with the RPC Broker component, see the "RPC Broker V. 1.1 Getting Started with the Broker Development Kit" manual.
This document is intended for the VISTA development community and Information Resource Management (IRM) staff. A wider audience of technical personnel engaged in operating and maintaining the Department of Veterans Affairs (VA) software might also find it useful as a reference.
Broker Overview
For the latest RPC Broker product information, please refer to the RPC Broker Home Page on the web at: http://vista.med.va.gov/broker/index.html.
Orientation
About this Version of the RPC Broker
This version of the Broker provides programmers with the capability to develop new VISTA client/server software using the Broker Delphi component (i.e., TRPCBroker) in the 32-bit environment.
What's New in the BDK
What’s New Through May 2002?
Support for Delphi V. 6.0
As of Patch XWB*1.1*13, the BDK supports Delphi V. 6.0.
Developer Considerations
Application Issues
Silent Login
Context-sensitive Help for the TRPCBroker Component
RPC Broker Components and Classes
TRPCBroker Component
New TRPCBroker Component Properties
As of Patch XWB*1.1*13, the following properties are new with this version of the RPC Broker:
- Property
- CurrentContext (Public)
- KerneLogIn (Published)
- LogIn (Public)
- OnRPCBFailure (Public)
- RPCBError (Public)
- ShowErrorMsgs (Published)
- User (Public)
