Secure Shell Protocol Functions
Function
Description
SshAsyncConnect
Connect asynchronously to the specified server
SshAttachThread
Attach the specified client handle to another thread
SshCancel
Cancel the current blocking operation
SshConnect
Connect to the specified server
SshControl
Send a control sequence to the server
SshCreateSecurityCredentials
Create a new security credentials structure
SshDeleteSecurityCredentials
Delete a previously created security credentials structure
SshDisableEvents
Disable asynchronous event notification
SshDisableTrace
Disable logging of socket function calls to the trace log
SshDisconnect
Disconnect from the current server
SshEnableEvents
Enable asynchronous event notification
SshEnableTrace
Enable logging of socket function calls to a file
SshEventProc
Callback function that processes events generated by the client
SshExecute
Execute a command on a server and return the output in the specified buffer
SshFreezeEvents
Suspend asynchronous event processing
SshGetErrorString
Return a description for the specified error code
SshGetExitCode
Return the exit code from the remote program
SshGetLastError
Return the last error code
SshGetLineMode
Return the current mode used to send end-of-line character sequences
SshGetSecurityInformation
Return security information about the current client connection
SshGetStatus
Return the current client status
SshGetTimeout
Return the number of seconds until an operation times out
SshInitialize
Initialize the library and validate the specified license key at runtime
SshIsBlocking
Determine if the client is blocked, waiting for information
SshIsConnected
Determine if the client is connected to the server
SshIsReadable
Determine if data can be read from the server
SshIsWritable
Determine if data can be written to the server
SshPeek
Read data returned by the server, but do not remove it from the receive buffer
SshRead
Read data returned by the server
SshReadLine
Read a line of text from the server and return it in a string buffer
SshRegisterEvent
Register an event callback function
SshSearch
Search for a specific character sequence in the data stream
SshSetLastError
Set the last error code
SshSetLineMode
Change how end-of-line character sequences are sent to the server
SshSetTimeout
Set the number of seconds until an operation times out
SshUninitialize
Terminate use of the library by the application
SshWrite
Write data to the server
SshWriteLine
Write a line of text to the server
Copyright © 2012 Catalyst Development Corporation. All rights reserved.