 | wclObexFtpClientPut(String, String, Stream) Method |
Sends one object from the client to a server.
Namespace: wclCommunicationAssembly: wclCommunication (in wclCommunication.dll) Version: 8.0.6.0
Syntaxpublic int Put(
string Name,
string Description,
Stream Stream
)
Public Function Put (
Name As String,
Description As String,
Stream As Stream
) As Integer
public:
int Put(
String^ Name,
String^ Description,
Stream^ Stream
)
Parameters
- Name String
-
An object's name.
- Description String
-
The object's description. If the parameter is an empty string the
Description is ignored.
- Stream Stream
-
The object's data stream.
Return Value
Int32
If the method completed with success the return value is
WCL_E_SUCCESS. Otherwise the method returns one of the
WCL error codes.
Remarks
The method starts sending an object to an OBEX server. When sending
is completed the OnPutComplete event is called with the
operation result.
If an application passes a valid Stream object to the method the
object must be valid until OnPutComplete event is called. An
application can destroy the stream object passed as the
Stream parameter only after OnPutComplete event is
called.
During execution of the Put operation the OnProgress event
may be called indicating the operation progress.
See Also