SshWrite
INT SshWrite(
HCLIENT hClient,  
LPBYTE lpBuffer,  
INT cbBuffer  
);

The SshWrite function sends the specified number of bytes to the remote host.

Parameters

hClient
Handle to the client session.
lpBuffer
The pointer to the buffer which contains the data that is to be sent to the remote host.
cbBuffer
The number of bytes to send from the specified buffer.

Return Value

If the function succeeds, the return value is the number of bytes actually written. If the function fails, the return value is SSH_ERROR. To get extended error information, call SshGetLastError.

Remarks

The return value may be less than the number of bytes specified by the cbBuffer parameter. In this case, the data has been partially written and it is the responsibility of the client application to send the remaining data at some later point. For non-blocking clients, the client must wait for the SSH_EVENT_WRITE asynchronous notification message before it resumes sending data.

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.
Unicode: Implemented as Unicode and ANSI versions.

See Also

SshRead


Copyright © 2008 Catalyst Development Corporation. All rights reserved.