Bluetooth Framework
ContentsIndexHome
PreviousUpNext
TwclCustomObexClient.Get Method

Requests an object from a server.

Syntax
Pascal
function Get(const Name: string; const Mime: string; const Stream: TStream): Integer;
Parameters 
Description 
const Name: string 
The object's name. If the parameter is an empty string the Name is ignored.  
const Mime: string 
The object's MIME type. If the parameter is an empty string the Mime is ignored.  
const Stream: TStream 
The object's data stream. This must be valid empty stream object. The stream must have write access permition.  

If the function succeed the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.

The method starts receiving an object from an OBEX server. When sending is completed the OnGetComplete event fires with the operation result.  

The Stream object passed to the method must be valid until OnGetComplete event fires. An application can destroy the stream object passed as the Stream parameter only after OnGetComplete event fired.  

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

 

Copyright (c) 2006-2019. All rights reserved.