Difference between revisions of "Broker help/TOC"

From VistApedia
Jump to: navigation, search
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]]  ===
==[[Broker_help\2 Tutorial]] ==
+
== Tutorial  ==
===[[Broker_help\3 Introduction=tut_intro]]  ===
+
===[[Broker_help\tut_intro| Introduction]]  ===
===[[Broker_help\3 Advanced Preparation=tut_prep]]  ===
+
===[[Broker_help\tut_prep| Advanced Preparation]]  ===
===[[Broker_help\3 Step  1: Create Application with an RPC Broker Component=tut_step1]]  ===
+
===[[Broker_help\tut_step1|Step  1: Create Application with an RPC Broker Component]]  ===
===[[Broker_help\3 Step  2: Get Server/Port=tut_step2]]  ===
+
===[[Broker_help\tut_step2|Step  2: Get Server/Port]]  ===
===[[Broker_help\3 Step  3: Establish Broker Connection=tut_step3]]  ====
+
===[[Broker_help\tut_step3|Step  3: Establish Broker Connection]]  ====
===[[Broker_help\3 Step  4: RPC Routine to List Terminal Types=tut_step4]]  ===
+
===[[Broker_help\tut_step4|Step  4: RPC Routine to List Terminal Types]]  ===
===[[Broker_help\3 Step  5: RPC to List Terminal Types=tut_step5]]  ===
+
===[[Broker_help\tut_step5|Step  5: RPC to List Terminal Types]]  ===
===[[Broker_help\3 Step  6: Call the ZxxxTT LIST RPC=tut_step6]]  ===
+
===[[Broker_help\tut_step6|Step  6: Call the ZxxxTT LIST RPC]]  ===
===[[Broker_help\3 Step  7: Associate IENs=tut_step7]]  ===
+
===[[Broker_help\tut_step7|Step  7: Associate IENs]]  ===
===[[Broker_help\3 Step  8: Routine to Retrieve Terminal Types=tut_step8]]  ===
+
===[[Broker_help\tut_step8|Step  8: Routine to Retrieve Terminal Types]]  ===
===[[Broker_help\3 Step  9: RPC to Retrieve Terminal Types=tut_step9]]  ===
+
===[[Broker_help\tut_step9|Step  9: RPC to Retrieve Terminal Types]]  ===
===[[Broker_help\3 Step 10: Call Zxxx RETRIEVE RPC=tut_step10]]  ===
+
===[[Broker_help\tut_step10|Step 10: Call Zxxx RETRIEVE RPC]]  ===
===[[Broker_help\3 Step 11: Register RPCs=tut_register]]  ===
+
===[[Broker_help\tut_register| Step 11: Register RPCs]]  ===
===[[Broker_help\3 See Also: FileMan Delphi Components (FMDC)=tut_fmdc]]  ===
+
===[[Broker_help\tut_fmdc|See Also: FileMan Delphi Components (FMDC)]]  ===
===[[Broker_help\3 Tutorial Source Code=tut_pascal]]  ===
+
===[[Broker_help\tut_pascal|Tutorial Source Code]]  ===
==[[Broker_help\2 DLL Interface]] ==
+
== DLL Interface  ==
===[[Broker_help\3 Introduction=dll_intro]] ===
+
===[[Broker_help\dll_intro| Introduction]] ===
===[[Broker_help\3 DLL Special Issues]] ===
+
== DLL Special Issues  ===
====[[Broker_help\4 RPC Results from DLL Calls=dll_results]]  ====
+
====[[Broker_help\dll_results|RPC Results from DLL Calls]]  ====
====[[Broker_help\4 GetServerInfo Function and the DLL=dll_getserverinfo]]  ====
+
====[[Broker_help\dll_getserverinfo|GetServerInfo Function and the DLL]]  ====
===[[Broker_help\3 DLL Exported Functions]] ===
+
=== DLL Exported Functions  ===
====[[Broker_help\4 RPCBCall=dll_function_rpcbcall]]  ====
+
====[[Broker_help\dll_function_rpcbcall|RPCBCall]]  ====
====[[Broker_help\4 RPCBCreate=dll_function_rpcbcreate]]  ====
+
====[[Broker_help\dll_function_rpcbcreate|RPCBCreate]]  ====
====[[Broker_help\4 RPCBCreateContext=dll_function_rpcbcreatecontext]]  ====
+
====[[Broker_help\dll_function_rpcbcreatecontext|RPCBCreateContext]]  ====
====[[Broker_help\4 RPCBFree=dll_function_rpcbfree]]  ====
+
====[[Broker_help\dll_function_rpcbfree|RPCBFree]]  ====
====[[Broker_help\4 RPCBMultItemGet=dll_function_rpcbmultitemget]]  ====
+
====[[Broker_help\dll_function_rpcbmultitemget|RPCBMultItemGet]]  ====
====[[Broker_help\4 RPCBMultPropGet=dll_function_rpcbmultpropget]]  ====
+
====[[Broker_help\dll_function_rpcbmultpropget|RPCBMultPropGet]]  ====
====[[Broker_help\4 RPCBMultSet=dll_function_rpcbmultset]]  ====
+
====[[Broker_help\dll_function_rpcbmultset|RPCBMultSet]]  ====
====[[Broker_help\4 RPCBMultSortedSet=dll_function_rpcbmultsortedset]]  ====
+
====[[Broker_help\dll_function_rpcbmultsortedset|RPCBMultSortedSet]]  ====
====[[Broker_help\4 RPCBParamGet=dll_function_rpcbParamGet]]  ====
+
====[[Broker_help\dll_function_rpcbParamGet|RPCBParamGet]]  ====
====[[Broker_help\4 RPCBParamSet=dll_function_rpcbParamSet]]  ====
+
====[[Broker_help\dll_function_rpcbParamSet|RPCBParamSet]]  ====
====[[Broker_help\4 RPCBPropGet=dll_function_rpcbpropget]]  ====
+
====[[Broker_help\dll_function_rpcbpropget|RPCBPropGet]]  ====
====[[Broker_help\4 RPCBPropSet=dll_function_rpcbpropset]]  ====
+
====[[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

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

Broker_help\3 M Entry Point for an RPC

Broker_help\4 Relationship Between an M Entry Point and an RPC=rpc_routine_relationship

Broker_help\4 First Input Parameter=rpc_first_input_param

Broker_help\4 Return Value Types=rpc_return_value_types

Broker_help\4 Input Parameters=rpc_input_parameter_types

Broker_help\4 Examples=rpc_entry_point_examples

Broker_help\3 RPC Entry in the Remote Procedure File

Broker_help\4 RPC Entry in the Remote Procedure File=rpc_file_entry

Broker_help\4 RPC Version in the Remote Procedure File=RPC_Version_in_Remote_Procedure_File

Broker_help\4 Blocking an RPC in the Remote Procedure File=Blocking_an_RPC

Broker_help\4 Cleanup after RPC Execution=rpc_cleanup

Broker_help\4 Documenting RPCs=rpc_document

Broker_help\3 Executing RPCs from Clients =

Broker_help\4 How to Execute an RPC from a Client=rpc_execute_from_client

Broker_help\4 RPC Security: How to Register an RPC=rpc_register

Broker_help\4 RPC Limits=RPC_limits

Broker_help\4 BrokerExample Online Code Example=BrokerExample

Broker_help\2 Other RPC Broker APIs

Broker_help\3 Overview=otherapi_Overview

Broker_help\3 Encryption Functions=otherapi_encrypt

Broker_help\3 GetServerInfo Function=otherapi_getserverinfo

Broker_help\3 M Emulation Functions=otherapi_m_emulation

Broker_help\3 VistA Splash Screen Procedures=otherapi_splash =

Broker_help\3 $$BROKER^XWBLIB=otherapi_broker

Broker_help\3 $$RTRNFMT^XWBLIB=otherapi_rtrnfmt

Broker_help\3 XWB ARE RPCS AVAILABLE=XWB_ARE_RPCS_AVAILABLE

Broker_help\3 XWB IS RPC AVAILABLE=XWB_IS_RPC_AVAILABLE

Broker_help\3 XWB GET VARIABLE VALUE RPC=otherapi_getvarvalue

Broker_help\3 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

Broker_help\4 Checking RPC Availability on a Remote Server=Checking_RPC_Availability_on_a_Remote_Server

Broker_help\4 XWB DIRECT RPC=XWB_DIRECT_RPC

Broker_help\4 XWB REMOTE RPC=XWB_REMOTE_RPC

Broker_help\4 XWB REMOTE STATUS CHECK=XWB_REMOTE_STATUS_CHECK

Broker_help\4 XWB REMOTE GETDATA=XWB_REMOTE_GETDATA

Broker_help\4 XWB REMOTE CLEAR=XWB_REMOTE_CLEAR

=Broker_help\3 Deferred RPCs

Broker_help\4 Overview of Deferred RPCs=Overview_of_Deferred_RPCs

Broker_help\4 XWB DEFERRED RPC=XWB_DEFERRED_RPC

Broker_help\4 XWB DEFERRED STATUS=XWB_DEFERRED_STATUS

Broker_help\4 XWB DEFERRED GETDATA=XWB_DEFERRED_GETDATA

Broker_help\4 XWB DEFERRED CLEAR=XWB_DEFERRED_CLEAR

Broker_help\4 XWB DEFERRED CLEARALL=XWB_DEFERRED_CLEARALL

Broker_help\2 Debugging and Troubleshooting

Broker_help\3 Overview=debug_overview

Broker_help\3 How to Debug Your Application=debug

Broker_help\3 RPC Error Trapping=Error_Handling

Broker_help\3 Identifying the Listener Process on the Server=ID_Listener

Broker_help\3 Identifying the Handler Process on the Server=ID_Handler

Broker_help\3 Testing Your RPC Broker Connection=Testing_Connection

Broker_help\3 Client Timeout and Buffer Clearing=Buffer_Clearing

Broker_help\3 Memory Leaks=memory_leaks

Broker_help\2 Developer Utilities

Broker_help\3 RPC Broker Programmer Preferences=IDH_brokprogpref

Tutorial

Introduction

Advanced Preparation

Step 1: Create Application with an RPC Broker Component

Step 2: Get Server/Port

Step 3: Establish Broker Connection =

Step 4: RPC Routine to List Terminal Types

Step 5: RPC to List Terminal Types

Step 6: Call the ZxxxTT LIST RPC

Step 7: Associate IENs

Step 8: Routine to Retrieve Terminal Types

Step 9: RPC to Retrieve Terminal Types

Step 10: Call Zxxx RETRIEVE RPC

Step 11: Register RPCs

See Also: FileMan Delphi Components (FMDC)

Tutorial Source Code

DLL Interface

Introduction

DLL Special Issues =

RPC Results from DLL Calls

GetServerInfo Function and the DLL

DLL Exported Functions

RPCBCall

RPCBCreate

RPCBCreateContext

RPCBFree

RPCBMultItemGet

RPCBMultPropGet

RPCBMultSet

RPCBMultSortedSet

RPCBParamGet

RPCBParamSet

RPCBPropGet

RPCBPropSet

Guidelines for C++

Overview

TRPCBroker C++ Class Methods

Initialize the Class

Create Broker Instances

Connect to the Server

Execute RPCs

Destroy Broker Instances

Guidelines for C

Overview

Initialize—LoadLibrary and GetProcAddress

Create Broker Components

Connect to the Server

Execute RPCs

Destroy Broker Components

Guidelines for Visual Basic

Overview

Initialize

Create Broker Components

Connect to the Server

Execute RPCs

Destroy Broker Components