TwclObexOppClient.Get(string,TStream) Method

The function reads the default object with given type from an OBEX Push server.

Namespace: wclObex
Delphi
public
 function Get(const aType: string; const Stream: TStream): Integer; overload;

Parameters

aType
Type: string

The object's type.

Stream
Type: TStream

The object's data stream.

Return Value

Type: Integer

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

This function can be used to pull (request) the default business card (vCard) from a target device. To do that the aType parameter must be "text/x-vCard" string.

An application must pass a valid Stream object to the method and the stream object 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.