This chapter provides a general introduction to some more advanced features of ExtraPuTTY. For extreme detail and reference purposes, chapter 4 is likely to contain more information.
To manage exchange with distant target :
For "TestStand" application 5 Steps are create :
1. Intialisation step used to establish the connexion, (used "Connexion_F" function of extraputty DLL) :
Parameters | Description |
---|---|
TargetName | TargetName or PuttySession Name (in this case Protocol must be equalt to 4). |
Login | optinonal parameter. |
Password | optinonal parameter. |
ShowPuTTY | TRUE: Putty Terminal is display, FALSE: not display. |
Protocol | 0:Telnet,1:SSH,2:Rlogin,3:Raw,4:LoadPutty Session. |
GenerateReport | 1:extraputty report activate,0:Not activate. |
CRLF | 1:0A0D,2:0D,3:0A,4:0D. |
NewCRLF | String used to replace the CRLF parameter find in data (for example CRLF = 1,NewCRLF : "br") |
ReportFileData | Parameter already set in step. Name and path of report generate by TestStand in order to generate extraputty report. |
arg10 | Parameter already set in step. State of the step (Pass or failed). |
arg11 | Parameter already set in step. Step result report. |
arg12 | Parameter already set in step. Error occured during step (True or false). |
arg13 | Parameter already set in step. Error code. |
arg14 | Parameter already set in step. Error Message. |
2. Send-Received data step used to send-received data, (used "SendRcvData_F" function of extraputty DLL) :
Parameters | Description |
---|---|
TargetName | The same TargetName or PuttySession Name used with connexion function. |
Command | Data to send to the target. |
Title | Title of your command,used only if extraputty report is activate. |
Comments | Comments of your command,used only if extraputty report is activate. |
TimeCapture | Time used to capture the reply data in ms. |
DataRcv | Parameter already set in step.Buffer which contain your data if TimerCapture is > 0. |
MaxSizeofData | Size of DataRcv Buffer or maximum data size in DataRcv |
Settings | Bit fields of settings (2^0 : CRLF (0 send,1 not send),...reserved) |
arg8 | Parameter already set in step. State of the step (Pass or failed). |
arg9 | Parameter already set in step. Step result report. |
arg10 | Parameter already set in step. Error occured during step (True or false). |
arg11 | Parameter already set in step. Error code. |
arg12 | Parameter already set in step. Error Message. |
5. Waiting Message step is used to wait one message on putty terminal, (used "WaitingMessage_F" function of extraputty DLL) :
Parameters | Description |
---|---|
TargetName | TargetName or PuttySession Name (in this case Protocol must be equal to 4). |
Message | Message to wait on putty terminal. |
TimeCapture | Timeout value of wait in ms. |
arg6 | State of the step (Pass or failed). |
arg7 | Step result report. |
arg8 | Error occured during step (True or false). |
arg9 | Error code. |
arg10 | Error Message. |
4. Close Connexion step used to close the current connexion, (used "CloseConnexion_F" function of extraputty DLL) :
Parameters | Description |
---|---|
TargetName | The same TargetName or PuttySession Name used with connexion function. |
arg2 | Parameter already set in step. State of the step (Pass or failed). |
arg3 | Parameter already set in step. Step result report. |
arg4 | Parameter already set in step. Error occured during step (True or false). |
arg5 | Parameter already set in step. Error code. |
arg6 | Parameter already set in step. Error Message. |
5. Close all Connexion step used to close all connexions, (used "CloseAllConnexion_F" function of extraputty DLL) :
Parameters | Description |
---|---|
arg1 | Parameter already set in step. State of the step (Pass or failed). |
arg2 | Parameter already set in step. Step result report. |
arg3 | Parameter already set in step. Error occured during step (True or false). |
arg4 | Parameter already set in step. Error code. |
arg5 | Parameter already set in step. Error Message. |
Note the following about ExtraPuTTY Windows Installer:
The ExtraPuTTY DLL need the path of PuTTY.
In order to do that you must create in the registry the key HKEY_CURRENT_USER\Software\SimonTatham\ExtraPutty\Path with the path where your PuTTY is install.
You can used this script to create this key, just edit the script to update the path of PuTTY install : ExtraPuTTY_RegKey.vbs
If you want to provide feedback on this manual or on the ExtraPuTTY tools themselves, see the Feedback page.
[ExtraPuTTY release 0.24 Compile with PuTTY relesase 0.60]