Command Property

The command to be sent to the remote host.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetCommand();
int SetCommand(const char* lpszCommand);

Unicode (Windows)
LPWSTR GetCommand();
INT SetCommand(LPCWSTR lpszCommand);

@property (nonatomic,readwrite,assign,getter=command,setter=setCommand:) NSString* command;
- (NSString*)command;
- (void)setCommand:(NSString*)newCommand;

#define PID_SEXEC_COMMAND 1

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SExec_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SExec_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

Assigning a command to this property makes the class attempt to connect to the SSHHost and execute the command under the user's shell. There is no need to append an end-of-line character to the command. All output from the remote application will be returned through the Stdout event.

Note: the class will terminate the connection once the remote application has finished executing. If the exit status of the application is non-zero (failure), the class will raise an exception.

Data Type

String