Revision as of 21:53, 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.

@@ Line 4: / Line 4: @@
 :Title RPC Broker Developer's Guide
-=[[RPC Broker V. 1.1 Developer's Guide]]  =
+=RPC Broker V. 1.1 Developer's Guide  =
-==[[Overview]]  ==
+==[[Broker_help\Overview |Overview]]  ==
 ===[[Broker_help\introduction |Introduction]]  ===
-Broker Overview=Broker_Overview]]  ===
+===[[Broker_help\Broker_Overview|Broker Overview]]  ===
-Orientation=Orientation]]  ===
+===[[Broker_help\3 Orientation=Orientation]]  ===
-About this Version of the RPC Broker=About_this_version]]  ===
+===[[Broker_help\3 About this Version of the RPC Broker=About_this_version]]  ===
-What's New in the BDK=Whats_New_in_the_BDK]]  ===
+===[[Broker_help\3 What's New in the BDK=Whats_New_in_the_BDK]]  ===
-Developer Considerations=Developer_Considerations]]  ===
+===[[Broker_help\3 Developer Considerations=Developer_Considerations]]  ===
-Application Issues=Application_Level_Issues]]  ===
+===[[Broker_help\3 Application Issues=Application_Level_Issues]]  ===
-Silent Login=Silent_Login]]  ===
+===[[Broker_help\3 Silent Login=Silent_Login]]  ===
-Context-sensitive Help for the TRPCBroker Component=ig_helpfile]]  ===
+===[[Broker_help\3 Context-sensitive Help for the TRPCBroker Component=ig_helpfile]]  ===
-RPC Broker Components and Classes]]  ==
+==[[Broker_help\2 RPC Broker Components and Classes]]  ==
-TRPCBroker Component=TRPCBroker]]  ===
+===[[Broker_help\3 TRPCBroker Component=TRPCBroker]]  ===
-TXWBRichEdit Component=TXWBRichEdit_Component]]  ===
+===[[Broker_help\3 TXWBRichEdit Component=TXWBRichEdit_Component]]  ===
-TMult Class=TMult_Class]]  ===
+===[[Broker_help\3 TMult Class=TMult_Class]]  ===
-TParamRecord Class=TParamRecord_Class]]  ===
+===[[Broker_help\3 TParamRecord Class=TParamRecord_Class]]  ===
-TParams Class=TParams_Class]]  ===
+===[[Broker_help\3 TParams Class=TParams_Class]]  ===
-TVistaLogin Class=TVistaLogin_Class]]  ===
+===[[Broker_help\3 TVistaLogin Class=TVistaLogin_Class]]  ===
-TVistaUser Class=TVistaUser_Class]]  ===
+===[[Broker_help\3 TVistaUser Class=TVistaUser_Class]]  ===
-EBrokerError Exception=EBrokerError]]  ===
+===[[Broker_help\3 EBrokerError Exception=EBrokerError]]  ===
-Units]]  ===
+===[[Broker_help\Units |Units]]  ===
-Hash Unit=Hash_unit]]  ====
+====[[Broker_help\4 Hash Unit=Hash_unit]]  ====
-LoginFrm Unit=LoginFrm_Unit]]  ====
+====[[Broker_help\4 LoginFrm Unit=LoginFrm_Unit]]  ====
-MFunStr Unit=MFunStr_unit]]  ====
+====[[Broker_help\4 MFunStr Unit=MFunStr_unit]]  ====
-RPCConf1 Unit=RPCConf1_unit]]  ====
+====[[Broker_help\4 RPCConf1 Unit=RPCConf1_unit]]  ====
-RpcSLogin Unit=RpcSLogin_Unit]]  ====
+====[[Broker_help\4 RpcSLogin Unit=RpcSLogin_Unit]]  ====
-SplVista Unit=SplVista_unit]]  ====
+====[[Broker_help\4 SplVista Unit=SplVista_unit]]  ====
-TRPCB Unit=TRPCB_unit]]  ====
+====[[Broker_help\4 TRPCB Unit=TRPCB_unit]]  ====
-TVCEdit Unit=TVCEdit_Unit]]  ====
+====[[Broker_help\4 TVCEdit Unit=TVCEdit_Unit]]  ====
-Remote Procedure Calls (RPCs)]]  ==
+==[[Broker_help\2 Remote Procedure Calls (RPCs)]]  ==
-Overview=rpc_overview]]  ===
+===[[Broker_help\3 Overview=rpc_overview]]  ===
-What Makes a Good RPC?=rpc_good]]  ===
+===[[Broker_help\3 What Makes a Good RPC?=rpc_good]]  ===
-Creating RPCs=rpc_create]]  ===
+===[[Broker_help\3 Creating RPCs=rpc_create]]  ===
-Using an Existing M API=Using_an_Existing_M_API
+===[[Broker_help\3 Using an Existing M API=Using_an_Existing_M_API
-M Entry Point for an RPC]]  ===
+===[[Broker_help\3 M Entry Point for an RPC]]  ===
-Relationship Between an M Entry Point and an RPC=rpc_routine_relationship]]  ====
+====[[Broker_help\4 Relationship Between an M Entry Point and an RPC=rpc_routine_relationship]]  ====
-First Input Parameter=rpc_first_input_param]]  ====
+====[[Broker_help\4 First Input Parameter=rpc_first_input_param]]  ====
-Return Value Types=rpc_return_value_types]]  ====
+====[[Broker_help\4 Return Value Types=rpc_return_value_types]]  ====
-Input Parameters=rpc_input_parameter_types]]  ====
+====[[Broker_help\4 Input Parameters=rpc_input_parameter_types]]  ====
-Examples=rpc_entry_point_examples]]  ====
+====[[Broker_help\4 Examples=rpc_entry_point_examples]]  ====
-RPC Entry in the Remote Procedure File]]  ===
+===[[Broker_help\3 RPC Entry in the Remote Procedure File]]  ===
-RPC Entry in the Remote Procedure File=rpc_file_entry]]  ====
+====[[Broker_help\4 RPC Entry in the Remote Procedure File=rpc_file_entry]]  ====
-RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File ]]  ====
+====[[Broker_help\4 RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File ]]  ====
-Blocking an RPC in the Remote Procedure File=Blocking_an_RPC]]  ====
+====[[Broker_help\4 Blocking an RPC in the Remote Procedure File=Blocking_an_RPC]]  ====
-Cleanup after RPC Execution=rpc_cleanup]]  ====
+====[[Broker_help\4 Cleanup after RPC Execution=rpc_cleanup]]  ====
-Documenting RPCs=rpc_document]]  ====
+====[[Broker_help\4 Documenting RPCs=rpc_document]]  ====
-Executing RPCs from Clients]]  ====
+===[[Broker_help\3 Executing RPCs from Clients]]  ====
-How to Execute an RPC from a Client=rpc_execute_from_client]]  ====
+====[[Broker_help\4 How to Execute an RPC from a Client=rpc_execute_from_client]]  ====
-RPC Security: How to Register an RPC=rpc_register]]  ====
+====[[Broker_help\4 RPC Security: How to Register an RPC=rpc_register]]  ====
-RPC Limits=RPC_limits]]  ====
+====[[Broker_help\4 RPC Limits=RPC_limits]]  ====
-BrokerExample Online Code Example=BrokerExample]]  ====
+====[[Broker_help\4 BrokerExample Online Code Example=BrokerExample]]  ====
-Other RPC Broker APIs]]  ==
+==[[Broker_help\2 Other RPC Broker APIs]]  ==
-Overview=otherapi_Overview]]  ===
+===[[Broker_help\3 Overview=otherapi_Overview]]  ===
-Encryption Functions=otherapi_encrypt]]  ===
+===[[Broker_help\3 Encryption Functions=otherapi_encrypt]]  ===
-GetServerInfo Function=otherapi_getserverinfo]]  ===
+===[[Broker_help\3 GetServerInfo Function=otherapi_getserverinfo]]  ===
-M Emulation Functions=otherapi_m_emulation]]  ===
+===[[Broker_help\3 M Emulation Functions=otherapi_m_emulation]]  ===
-VistA Splash Screen Procedures=otherapi_splash]]  ====
+===[[Broker_help\3 VistA Splash Screen Procedures=otherapi_splash]]  ====
-$$BROKER^XWBLIB=otherapi_broker]]  ===
+===[[Broker_help\3 $$BROKER^XWBLIB=otherapi_broker]]  ===
-$$RTRNFMT^XWBLIB=otherapi_rtrnfmt]]  ===
+===[[Broker_help\3 $$RTRNFMT^XWBLIB=otherapi_rtrnfmt]]  ===
-XWB ARE RPCS AVAILABLE=XWB_ARE_RPCS_AVAILABLE]]  ===
+===[[Broker_help\3 XWB ARE RPCS AVAILABLE=XWB_ARE_RPCS_AVAILABLE]]  ===
-XWB IS RPC AVAILABLE=XWB_IS_RPC_AVAILABLE]]  ===
+===[[Broker_help\3 XWB IS RPC AVAILABLE=XWB_IS_RPC_AVAILABLE]]  ===
-XWB GET VARIABLE VALUE RPC=otherapi_getvarvalue]]  ===
+===[[Broker_help\3 XWB GET VARIABLE VALUE RPC=otherapi_getvarvalue]]  ===
-Running RPCs on a Remote Server]]  ===
+===[[Broker_help\3 Running RPCs on a Remote Server]]  ===
-Options For Running RPCs on a Remote Server=Options_For_Running_RPCs_on_a_Remote_Server]]  ====
+====[[Broker_help\4 Options For Running RPCs on a Remote Server=Options_For_Running_RPCs_on_a_Remote_Server]]  ====
-Checking RPC Availability on a Remote  Server=Checking_RPC_Availability_on_a_Remote_Server]]  ====
+====[[Broker_help\4 Checking RPC Availability on a Remote  Server=Checking_RPC_Availability_on_a_Remote_Server]]  ====
-XWB DIRECT RPC=XWB_DIRECT_RPC]]  ====
+====[[Broker_help\4 XWB DIRECT RPC=XWB_DIRECT_RPC]]  ====
-XWB REMOTE RPC=XWB_REMOTE_RPC]]  ====
+====[[Broker_help\4 XWB REMOTE RPC=XWB_REMOTE_RPC]]  ====
-XWB REMOTE STATUS CHECK=XWB_REMOTE_STATUS_CHECK]]  ====
+====[[Broker_help\4 XWB REMOTE STATUS CHECK=XWB_REMOTE_STATUS_CHECK]]  ====
-XWB REMOTE GETDATA=XWB_REMOTE_GETDATA]]  ====
+====[[Broker_help\4 XWB REMOTE GETDATA=XWB_REMOTE_GETDATA]]  ====
-XWB REMOTE CLEAR=XWB_REMOTE_CLEAR]]  ====
+====[[Broker_help\4 XWB REMOTE CLEAR=XWB_REMOTE_CLEAR]]  ====
-Deferred RPCs]]  ===
+====[[Broker_help\3 Deferred RPCs]]  ===
-Overview of Deferred RPCs=Overview_of_Deferred_RPCs]]  ====
+====[[Broker_help\4 Overview of Deferred RPCs=Overview_of_Deferred_RPCs]]  ====
-XWB DEFERRED RPC=XWB_DEFERRED_RPC]]  ====
+====[[Broker_help\4 XWB DEFERRED RPC=XWB_DEFERRED_RPC]]  ====
-XWB DEFERRED STATUS=XWB_DEFERRED_STATUS]]  ====
+====[[Broker_help\4 XWB DEFERRED STATUS=XWB_DEFERRED_STATUS]]  ====
-XWB DEFERRED GETDATA=XWB_DEFERRED_GETDATA]]  ====
+====[[Broker_help\4 XWB DEFERRED GETDATA=XWB_DEFERRED_GETDATA]]  ====
-XWB DEFERRED CLEAR=XWB_DEFERRED_CLEAR]]  ====
+====[[Broker_help\4 XWB DEFERRED CLEAR=XWB_DEFERRED_CLEAR]]  ====
-XWB DEFERRED CLEARALL=XWB_DEFERRED_CLEARALL]]  ====
+====[[Broker_help\4 XWB DEFERRED CLEARALL=XWB_DEFERRED_CLEARALL]]  ====
-Debugging and Troubleshooting]]  ==
+==[[Broker_help\2 Debugging and Troubleshooting]]  ==
-Overview=debug_overview]]  ===
+===[[Broker_help\3 Overview=debug_overview]]  ===
-How to Debug Your Application=debug]]  ===
+===[[Broker_help\3 How to Debug Your Application=debug]]  ===
-RPC Error Trapping=Error_Handling]]  ===
+===[[Broker_help\3 RPC Error Trapping=Error_Handling]]  ===
-Identifying the Listener Process on the Server=ID_Listener]]  ===
+===[[Broker_help\3 Identifying the Listener Process on the Server=ID_Listener]]  ===
-Identifying the Handler Process on the Server=ID_Handler]]  ===
+===[[Broker_help\3 Identifying the Handler Process on the Server=ID_Handler]]  ===
-Testing Your RPC Broker Connection=Testing_Connection]]  ===
+===[[Broker_help\3 Testing Your RPC Broker Connection=Testing_Connection]]  ===
-Client Timeout and Buffer Clearing=Buffer_Clearing]]  ===
+===[[Broker_help\3 Client Timeout and Buffer Clearing=Buffer_Clearing]]  ===
-Memory Leaks=memory_leaks]]  ===
+===[[Broker_help\3 Memory Leaks=memory_leaks]]  ===
-Developer Utilities]]  ==
+==[[Broker_help\2 Developer Utilities]]  ==
-RPC Broker Programmer Preferences=IDH_brokprogpref]]  ===
+===[[Broker_help\3 RPC Broker Programmer Preferences=IDH_brokprogpref]]  ===
-Tutorial]]  ==
+==[[Broker_help\2 Tutorial]]  ==
-Introduction=tut_intro]]  ===
+===[[Broker_help\3 Introduction=tut_intro]]  ===
-Advanced Preparation=tut_prep]]  ===
+===[[Broker_help\3 Advanced Preparation=tut_prep]]  ===
-Step  1: Create Application with an RPC Broker Component=tut_step1]]  ===
+===[[Broker_help\3 Step  1: Create Application with an RPC Broker Component=tut_step1]]  ===
-Step  2: Get Server/Port=tut_step2]]  ===
+===[[Broker_help\3 Step  2: Get Server/Port=tut_step2]]  ===
-Step  3: Establish Broker Connection=tut_step3]]  ====
+===[[Broker_help\3 Step  3: Establish Broker Connection=tut_step3]]  ====
-Step  4: RPC Routine to List Terminal Types=tut_step4]]  ===
+===[[Broker_help\3 Step  4: RPC Routine to List Terminal Types=tut_step4]]  ===
-Step  5: RPC to List Terminal Types=tut_step5]]  ===
+===[[Broker_help\3 Step  5: RPC to List Terminal Types=tut_step5]]  ===
-Step  6: Call the ZxxxTT LIST RPC=tut_step6]]  ===
+===[[Broker_help\3 Step  6: Call the ZxxxTT LIST RPC=tut_step6]]  ===
-Step  7: Associate IENs=tut_step7]]  ===
+===[[Broker_help\3 Step  7: Associate IENs=tut_step7]]  ===
-Step  8: Routine to Retrieve Terminal Types=tut_step8]]  ===
+===[[Broker_help\3 Step  8: Routine to Retrieve Terminal Types=tut_step8]]  ===
-Step  9: RPC to Retrieve Terminal Types=tut_step9]]  ===
+===[[Broker_help\3 Step  9: RPC to Retrieve Terminal Types=tut_step9]]  ===
-Step 10: Call Zxxx RETRIEVE RPC=tut_step10]]  ===
+===[[Broker_help\3 Step 10: Call Zxxx RETRIEVE RPC=tut_step10]]  ===
-Step 11: Register RPCs=tut_register]]  ===
+===[[Broker_help\3 Step 11: Register RPCs=tut_register]]  ===
-See Also: FileMan Delphi Components (FMDC)=tut_fmdc]]  ===
+===[[Broker_help\3 See Also: FileMan Delphi Components (FMDC)=tut_fmdc]]  ===
-Tutorial Source Code=tut_pascal]]  ===
+===[[Broker_help\3 Tutorial Source Code=tut_pascal]]  ===
-DLL Interface]]  ==
+==[[Broker_help\2 DLL Interface]]  ==
-Introduction=dll_intro]]  ===
+===[[Broker_help\3 Introduction=dll_intro]]  ===
-DLL Special Issues]]  ===
+===[[Broker_help\3 DLL Special Issues]]  ===
-RPC Results from DLL Calls=dll_results]]  ====
+====[[Broker_help\4 RPC Results from DLL Calls=dll_results]]  ====
-GetServerInfo Function and the DLL=dll_getserverinfo]]  ====
+====[[Broker_help\4 GetServerInfo Function and the DLL=dll_getserverinfo]]  ====
-DLL Exported Functions]]  ===
+===[[Broker_help\3 DLL Exported Functions]]  ===
-RPCBCall=dll_function_rpcbcall]]  ====
+====[[Broker_help\4 RPCBCall=dll_function_rpcbcall]]  ====
-RPCBCreate=dll_function_rpcbcreate]]  ====
+====[[Broker_help\4 RPCBCreate=dll_function_rpcbcreate]]  ====
-RPCBCreateContext=dll_function_rpcbcreatecontext]]  ====
+====[[Broker_help\4 RPCBCreateContext=dll_function_rpcbcreatecontext]]  ====
-RPCBFree=dll_function_rpcbfree]]  ====
+====[[Broker_help\4 RPCBFree=dll_function_rpcbfree]]  ====
-RPCBMultItemGet=dll_function_rpcbmultitemget]]  ====
+====[[Broker_help\4 RPCBMultItemGet=dll_function_rpcbmultitemget]]  ====
-RPCBMultPropGet=dll_function_rpcbmultpropget]]  ====
+====[[Broker_help\4 RPCBMultPropGet=dll_function_rpcbmultpropget]]  ====
-RPCBMultSet=dll_function_rpcbmultset]]  ====
+====[[Broker_help\4 RPCBMultSet=dll_function_rpcbmultset]]  ====
-RPCBMultSortedSet=dll_function_rpcbmultsortedset]]  ====
+====[[Broker_help\4 RPCBMultSortedSet=dll_function_rpcbmultsortedset]]  ====
-RPCBParamGet=dll_function_rpcbParamGet]]  ====
+====[[Broker_help\4 RPCBParamGet=dll_function_rpcbParamGet]]  ====
-RPCBParamSet=dll_function_rpcbParamSet]]  ====
+====[[Broker_help\4 RPCBParamSet=dll_function_rpcbParamSet]]  ====
-RPCBPropGet=dll_function_rpcbpropget]]  ====
+====[[Broker_help\4 RPCBPropGet=dll_function_rpcbpropget]]  ====
-RPCBPropSet=dll_function_rpcbpropset]]  ====
+====[[Broker_help\4 RPCBPropSet=dll_function_rpcbpropset]]  ====
-Guidelines for C++]]  ===
+===[[Broker_help\3 Guidelines for C++]]  ===
-Overview=dll_cpp_intro]]  ====
+====[[Broker_help\4 Overview=dll_cpp_intro]]  ====
-TRPCBroker C++ Class Methods=dll_cpp_methods]]  ====
+====[[Broker_help\4 TRPCBroker C++ Class Methods=dll_cpp_methods]]  ====
-Initialize the Class=dll_cpp_init]]  ====
+====[[Broker_help\4 Initialize the Class=dll_cpp_init]]  ====
-Create Broker Instances=dll_cpp_create]]  ====
+====[[Broker_help\4 Create Broker Instances=dll_cpp_create]]  ====
-Connect to the Server=dll_cpp_connect]]  ====
+====[[Broker_help\4 Connect to the Server=dll_cpp_connect]]  ====
-Execute RPCs=dll_cpp_execute]]  ====
+====[[Broker_help\4 Execute RPCs=dll_cpp_execute]]  ====
-Destroy Broker Instances=dll_cpp_destroy]]  ====
+====[[Broker_help\4 Destroy Broker Instances=dll_cpp_destroy]]  ====
-Guidelines for C]]  ===
+===[[Broker_help\3 Guidelines for C]]  ===
-Overview=dll_c_intro]]  ====
+====[[Broker_help\4 Overview=dll_c_intro]]  ====
-Initialize—LoadLibrary and GetProcAddress=dll_c_init]]  ====
+====[[Broker_help\4 Initialize—LoadLibrary and GetProcAddress=dll_c_init]]  ====
-Create Broker Components=dll_c_create]]  ====
+====[[Broker_help\4 Create Broker Components=dll_c_create]]  ====
-Connect to the Server=dll_c_connect]]  ====
+====[[Broker_help\4 Connect to the Server=dll_c_connect]]  ====
-Execute RPCs=dll_c_execute]]  ====
+====[[Broker_help\4 Execute RPCs=dll_c_execute]]  ====
-Destroy Broker Components=dll_c_destroy]]  ====
+====[[Broker_help\4 Destroy Broker Components=dll_c_destroy]]  ====
-Guidelines for Visual Basic]]  ===
+===[[Broker_help\3 Guidelines for Visual Basic]]  ===
-Overview=dll_vb_intro]]  ====
+====[[Broker_help\4 Overview=dll_vb_intro]]  ====
-Initialize=dll_vb_init]]  ====
+====[[Broker_help\4 Initialize=dll_vb_init]]  ====
-Create Broker Components=dll_vb_create]]  ====
+====[[Broker_help\4 Create Broker Components=dll_vb_create]]  ====
-Connect to the Server=dll_vb_connect]]  ====
+====[[Broker_help\4 Connect to the Server=dll_vb_connect]]  ====
-Execute RPCs=dll_vb_execute]]  ====
+====[[Broker_help\4 Execute RPCs=dll_vb_execute]]  ====
-==== [[/Destroy Broker Components=dll_vb_destroy]]  ====
+====[[Broker_help\Destroy Broker Components=dll_vb_destroy]]  ====

Difference between revisions of "Broker help/TOC"

Revision as of 21:53, 20 December 2010

Contents

RPC Broker V. 1.1 Developer's Guide

Broker_help\3 Executing RPCs from Clients =

Broker_help\3 VistA Splash Screen Procedures=otherapi_splash =

=Broker_help\3 Deferred RPCs

Broker_help\3 Step 3: Establish Broker Connection=tut_step3 =

Navigation menu