Serial Framework C++ Edition

◆ Put()

int Put ( const tstring &  Name,
const tstring &  Description,
CwclStream *const  Stream 
)

Sends one object from the client to the server.

Parameters
NameThe object's name. If the parameter is an empty string the Name is ignored.
DescriptionThe object's description. If the parameter is an empty string the Description is ignored.
StreamThe object's data stream.
Returns
If the function succeed the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

The method starts sending an object to an OBEX server. When sending is completed the OnPutComplete event fires with the operation result.

If an application passes a valid Stream object to the method the object must be valid until OnPutComplete event fires. An application can destroy the stream object passed as the Stream parameter only after OnPutComplete event fired.

During execution of the Put operation the OnProgress event may (or may not) fire indicating the operation progress.

See also
CwclStream