TwclObexFtpClient.Get(string,TStream) Method
Requests an object from a server.
public function Get(const Name: string; const Stream: TStream): Integer;
Parameters
- Name
- Type: string
The object's name. If the parameter is an empty string the Name is ignored.
- Stream
- Type: TStream
The object's data stream. This must be valid empty stream object. The stream must have write access permition.
Return Value
If the function succeed the return value is wclErrors.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.