 | wclObexFtpClientGet(String, Stream) Method |
Requests an object from a server.
Namespace: wclCommunicationAssembly: wclCommunication (in wclCommunication.dll) Version: 8.0.6.0
Syntaxpublic int Get(
string Name,
Stream Stream
)
Public Function Get (
Name As String,
Stream As Stream
) As Integer
public:
int Get(
String^ Name,
Stream^ Stream
)
Parameters
- Name String
-
An object's name. If the parameter is an empty string the Name is
ignored.
- Stream Stream
-
An object's data stream. This must be valid empty stream object. The
stream must have write access permition.
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
sending is completed the OnGetComplete event is called with
the operation result.
The stream object passed to the method must be valid until the
OnGetComplete event is called. An application can destroy
the stream object passed as the Stream parameter only after
the OnGetComplete event is called.
During execution of the Get operation the OnProgress event
may be called indicating the operation progress.
See Also