| |
The SSHOPTIONDATA structure specifies additional option
information for the client session.
typedef struct _SSHOPTIONDATA
{
DWORD dwSize;
DWORD dwReserved;
UINT nProxyType;
UINT nProxyPort;
TCHAR szProxyHost[128];
TCHAR szProxyUser[128];
TCHAR szProxyPassword[128];
UINT nTermCols;
UINT nTermRows;
TCHAR szTermName[32];
TCHAR szCommandLine[512];
} SSHOPTIONDATA, *LPSSHOPTIONDATA;
Members
- dwSize
- An unsigned integer value which specifies the size of the
SSHOPTIONDATA structure. This member must be initialized prior to
passing the structure to the Connect method.
- dwReserved
- An unsigned integer value that is reserved for internal use,
and should always be initialized to a value of zero.
- nProxyType
- An unsigned integer value that specifies the type of proxy that
the client should connect through. This structure member is only
used if the option SSH_OPTION_PROXYSERVER has been specified.
Possible values are:
| Value |
Description |
| SSH_PROXY_NONE |
No proxy server should be used when establishing the
connection. |
| SSH_PROXY_HTTP |
The connection should be established on port 80 using HTTP.
An alternate port number can be specified by setting the
nProxyPort structure member to the desired value. |
| SSH_PROXY_TELNET |
The connection should be established on port 23 using
TELNET. An alternate port number can be specified by setting
the nProxyPort structure member to the desired
value. |
- nProxyPort
- An unsigned integer value that specifies the port number which
should be used to establish the proxy connection. A value of zero
specifies that the default port number appropriate for the selected
protocol should be used. This structure member is only used if the
option SSH_OPTION_PROXYSERVER has been specified.
- szProxyHost
- A null terminated string which specifies the host name or IP
address of the proxy server. This structure member is only used if
the option SSH_OPTION_PROXYSERVER has been specified.
- szProxyUser
- A null terminated string which specifies the user name which is
used to authenticate the connection through the proxy server. This
structure member is only used if the option SSH_OPTION_PROXYSERVER
has been specified.
- szProxyPassword
- A null terminated string which specifies the password which is
used to authenticate the connection through the proxy server. This
structure member is only used if the option SSH_OPTION_PROXYSERVER
has been specified.
- nTermCols
- An unsigned integer value which specifies the number of columns
for the virtual terminal allocated for the client session. The
default number of columns is 80. This structure member is only used
if the option SSH_OPTION_TERMINAL has been specified.
- nTermRows
- An unsigned integer value which specifies the number of rows
for the virtual terminal allocated for the client session. The
default number of rows is 25. This structure member is only used if
the option SSH_OPTION_TERMINAL has been specified.
- szTermName
- A null terminated string which specifies the name of the
terminal emulation type. On UNIX based systems, this name typically
corresponds to an entry in the terminal capability database (either
termcap or terminfo). If the name is not specified, then the
default name terminal name of "unknown" will be used.
This structure member is only used if the option
SSH_OPTION_TERMINAL has been specified.
- szCommandLine
- A null terminated string which specifies the command that
should be executed on the server. The output from the command
is returned to the client, and the session is terminated. This
structure member is only used if the option SSH_OPTION_COMMAND has
been specified.
Requirements
Minimum Desktop Platform: Windows 7 Service Pack 1
Minimum Server Platform: Windows Server 2008 R2 Service Pack 1
Header File: cstools11.h
Unicode: Implemented as Unicode and ANSI versions
|
|