Click or drag to resize

wclCustomObexClientPut Method

Sends one object from the client to a server.

Namespace: wclCommunication
Assembly: wclCommunication (in wclCommunication.dll) Version: 8.0.6.0
Syntax
protected int Put(
	string Name,
	string Mime,
	string Description,
	Stream Stream,
	byte[] AppParams
)

Parameters

Name  String
An object's name. If the parameter is an empty string the Name is ignored.
Mime  String
An object's MIME type. If the parameter is an empty string the Mime is ignored.
Description  String
An object's description. If the parameter is an empty string the Description is ignored.
Stream  Stream
An object's data stream. If the parameter is nil it forces to delete the object with the name specified in the Name parameter or with the MIME type specified in the Mime parameter. If the Stream parameter is an empty stream (it is not nil and the Stream size is 0) it forces a server to create new empty object with the given Name or MIME.
AppParams  Byte
A pointer to an additional application parameters raw bytes.

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 in the Stream parameter the Stream must be valid until the OnPutComplete event is called. An application can destroy the Stream object passed in the Stream parameter only after the OnPutComplete event called.

During execution of the Put operation the OnProgress event may be called indicating the operation progress.

See Also