Serial Framework C++ Edition

◆ Put()

int Put ( const tstring &  Name,
const tstring &  Mime,
const tstring &  Description,
CwclStream *const  Stream,
const unsigned char *const  AppParams,
const unsigned short  AppParamsLength 
)
protected

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.
MimeThe object's MIME type. If the parameter is an empty string the Mime is ignored.
DescriptionThe object's description. If the parameter is an empty string the Description is ignored.
StreamThe object's data stream. If the parameter is NULL it forces to delete the object with the name specified by the Name parameter or with MIME type specified by the Mime parameter. If the Stream parameter is an empty stream (it is not NULL and the Stream size is 0) it forces a server to create an empty object with the given Name or MIME.
AppParamsThe application parameters raw bytes.
AppParamsLengthThe length of the application parameters.
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 (or other operation described above) to a 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