StartService Method

Requests the given service on a target channel.

Syntax

int StartService(const QString& qsChannelId, const QString& qsService, const QString& qsParameter);

Remarks

After a "session" channel has been opened by a call to OpenChannel, a service may be requested for that channel. ChannelId identifies the channel on which the service is to be started.

Service identifies the service being requested. The following list defines some known services:

"shell"Starts a shell on the
"exec"Executes the command identified by Parameter.
"subsystem"Starts up a subsystem identified by Parameter, such as "sftp".

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Qt Edition - Version 20.0 [Build 8501]