脚本API之xsh.session

Functions

返回值

函数

参数

说明

Void

OpenSession(LPCTSTR lpszSession)

lpszSession

是字符串，指Xshell会话路径或Xshell使用的URL类型。

打开新会话或URL。

为打开会话把 /s选项置于字符串的前端。例)在打开A.xsh 会话时使用‘/s $PATH/A.xsh’。

Void

CloseSession()

退出当前连接的会话。

Void

Sleep(long timeout)

Timeout

毫秒单位的时间值

Xshell按照指定时间进行待机。

Void

LogFilePath(LPCTSTR lpszNewFilePath)

lpszNewFilePath

包括路径在内的文件名

指定日志文件。

void

StartLog()

开始会话的日志记录。日志将被保存到LogFilePath()指定的路径。如未指定日志文件路径则使用默认路径。

void

StopLog()

停止日志记录。

参数

名称

类型

说明

Connected

BOOL

是否连接当前会话。

LocalAddress

BSTR

导入本地地址。

Path

BSTR

导入当前会话文件的路径。

RemoteAddress

BSTR

导入远程地址。

RemotePort

long

导入远程端口号。

Logging

BOOL

确认当前会话是否记录日志。