StartService Method
Requests the given service on a target channel.
Syntax
ANSI (Cross Platform) int StartService(const char* lpszChannelId, const char* lpszService, const char* lpszParameter); Unicode (Windows) INT StartService(LPCWSTR lpszChannelId, LPCWSTR lpszService, LPCWSTR lpszParameter);
- (void)startService:(NSString*)channelId :(NSString*)service :(NSString*)parameter;
#define MID_SSHCLIENT_STARTSERVICE 19 IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHClient_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
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 (C++)
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.)