Difference between revisions of "RPC HELP TVistaLogin LoginHandle"
Line 8: | Line 8: | ||
<h3>Description</h3> | <h3>Description</h3> | ||
− | The LoginHandle property is available at run-time only. It holds the Application Handle for the lmAppHandle mode of [[RPC_HELP_Silent_Login|Silent Login]]. The Application Handle is obtained from the VistA M Server by a currently running application using the GetAppHandle function in the [[RPC_HELP_TRPCB_Unit|TRPCB Unit]]. The function returns a String value, which is then passed as a command line argument with an application that is being started. The new application must know to look for the handle, and if present, set up the [[RPC_HELP_Silent_Login|Silent Login]]. The [[RPC_HELP_Silent_RpcSLogin_StartProgSLogin|StartProgSLogin]] procedure in the [[ | + | The LoginHandle property is available at run-time only. It holds the Application Handle for the lmAppHandle mode of [[RPC_HELP_Silent_Login|Silent Login]]. The Application Handle is obtained from the VistA M Server by a currently running application using the GetAppHandle function in the [[RPC_HELP_TRPCB_Unit|TRPCB Unit]]. The function returns a String value, which is then passed as a command line argument with an application that is being started. The new application must know to look for the handle, and if present, set up the [[RPC_HELP_Silent_Login|Silent Login]]. The [[RPC_HELP_Silent_RpcSLogin_StartProgSLogin|StartProgSLogin]] procedure in the [[RPC_HELP_RpcSLogin|RpcSLogin unit]] can be used directly or as an example of how the application would be started with a valid AppHandle as a command line argument. The [[RPC_HELP_Silent_RpcSLogin_CheckCmdLine|CheckCmdLine]] procedure in the [[RPC_HELP_RpcSLogin|RpcSLogin unit]] can be used in an application to determine whether an AppHandle has been passed and to initiate the Broker connection or used as an example of how this could be done. |
− | NOTE: The two procedures referenced here also pass the current [[ | + | NOTE: The two procedures referenced here also pass the current [[RPC_HELP_TRPCBroker_Server|Server]], [[RPC_HELP_TRPCBroker_ListenerPort|ListenerPort]], and [[RPC_HELP_TVistaLogin_Division|Division]] for the user so that the connection would be made to the same VistA M Server as the original application. |
The AppHandle that is obtained via the GetAppHandle function is only valid for approximately 20 seconds, after which the Silent Login would fail. | The AppHandle that is obtained via the GetAppHandle function is only valid for approximately 20 seconds, after which the Silent Login would fail. | ||
NOTE: For a demonstration using the lmAppHandle, please run the lmAppHandle_Demo.EXE located in the ..\BDK32\Samples\SilentSignOn directory. | NOTE: For a demonstration using the lmAppHandle, please run the lmAppHandle_Demo.EXE located in the ..\BDK32\Samples\SilentSignOn directory. |
Latest revision as of 18:35, 8 July 2015
LoginHandle Property
Applies to
TVistaLogin class
Declaration
property LoginHandle: String;
Description
The LoginHandle property is available at run-time only. It holds the Application Handle for the lmAppHandle mode of Silent Login. The Application Handle is obtained from the VistA M Server by a currently running application using the GetAppHandle function in the TRPCB Unit. The function returns a String value, which is then passed as a command line argument with an application that is being started. The new application must know to look for the handle, and if present, set up the Silent Login. The StartProgSLogin procedure in the RpcSLogin unit can be used directly or as an example of how the application would be started with a valid AppHandle as a command line argument. The CheckCmdLine procedure in the RpcSLogin unit can be used in an application to determine whether an AppHandle has been passed and to initiate the Broker connection or used as an example of how this could be done.
NOTE: The two procedures referenced here also pass the current Server, ListenerPort, and Division for the user so that the connection would be made to the same VistA M Server as the original application.
The AppHandle that is obtained via the GetAppHandle function is only valid for approximately 20 seconds, after which the Silent Login would fail.
NOTE: For a demonstration using the lmAppHandle, please run the lmAppHandle_Demo.EXE located in the ..\BDK32\Samples\SilentSignOn directory.