Click or drag to resize

wclCustomObexClientGet Method

Requests an object from a server.

Namespace: wclCommunication
Assembly: wclCommunication (in wclCommunication.dll) Version: 8.0.6.0
Syntax
protected int Get(
	string Name,
	string Mime,
	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.
Stream  Stream
An object's data stream. This must be a valid empty stream object. The stream must have write access permition.
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 receiving an object from an OBEX server. When receiving is completed the OnGetComplete event is called with the operation result.

A Stream object passed to the method must be valid until the OnGetComplete event called. An application can destroy a stream object passed as the Stream parameter only after then OnGetComplete event is called.

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

See Also