| INT Control( |
| |
DWORD dwControlCode |
|
| ); |
The SshControl function sends a control message to the
server.
Parameters
- dwControlCode
- A numeric control code which specifies the control message
which should be sent to the server. This may be one of the
following values:
| Value |
Description |
| SSH_CONTROL_BREAK |
Sends a control message to the server which simulates
a break signal on a physical terminal. This is used by some
operating systems as an instruction to enter a privileged
configuration mode. Note that this is not the same as sending
an interrupt character such as Ctrl+C to the server. This
control code is ignored for SSH 1.0 sessions. |
| SSH_CONTROL_NOOP |
Sends a control message to the server, but it does not
perform any operation. This is typically used by clients to
prevent the server from automatically closing a session that
has been idle for a long period of time. |
| SSH_CONTROL_EOF |
Sends a control message to the server indicating that
the client has finished sending data. Note that this option is
normally not used with interactive terminal sessions, and
should only be used when required by the server. |
| SSH_CONTROL_PING |
Sends a control message to the server which is used to
test whether or not the server is responsive to the
client. This is typically used by clients to attempt to detect
if the connection to the server is still active. |
| SSH_CONTROL_REKEY |
Sends a control message to the server requesting that
the key exchange be performed again. This control code is
ignored for SSH 1.0 sessions. |
Return Value
If the function succeeds, the return value is zero. If the
function fails, the return value is SSH_ERROR. To get extended error
information, call the GetLastError method.
Remarks
The Control method enables an application to send control
messages to the server, which can cause it to take specific
actions such as simulate a terminal break or request that the key
exchanged be performed again. Some control messages are not supported
by the SSH 1.0 protocol, in which case the control message is
ignored.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Import Library: cstshv11.lib
See Also
Break, Cancel,
IsBlocking
|