| INT
SshGetExitCode(
|
|
|
HCLIENT hClient |
|
|
| );
|
The SshGetExitCode function returns the exit code for the
remote session.
Parameters
- hClient
- Handle to the client session.
Return Value
If the function succeeds, the return value is the numeric exit
code. If the function fails, the return value is SSH_ERROR. To get
extended error information, call SshGetLastError.
Remarks
This function should only be called after the command has
completed and the SshRead function has returned a
value of zero. In most cases, an exit code value of zero indicates
success, while any other value indicates an error condition.
Note that the actual value is application dependent and is only
meaningful in the context of that particular program. A program may
choose or use exit codes in a non-standard way, such as having
certain non-zero values indicate success.
Requirements
Client: Requires Windows Vista, Windows XP or Windows
2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or
Windows 2000 Server.
Header: Include cstools6.h.
Library: Use cstshav6.lib.
See Also
SshGetStatus
|