IrDA Framework
ContentsIndexHome
PreviousUpNext
TwclObexOppClient.Push Method

Sends one object from the client to the server.

Syntax
Pascal
function Push(const Name: string; const Description: 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 Description: string 
The object's description. If the parameter is an empty string the Description is ignored.  
const Stream: TStream 
The object's data stream.  

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 Push operation the OnProgress event may (or may not) fire indicating the operation progress.  

 

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