wclCustomObexClientGet Method |
Requests an object from a server.
Namespace: wclCommunicationAssembly: wclCommunication (in wclCommunication.dll) Version: 7.9.6.0 (7.9.6.0)
Syntaxprotected int Get(
string Name,
string Mime,
Stream Stream,
byte[] AppParams
)
Protected Function Get (
Name As String,
Mime As String,
Stream As Stream,
AppParams As Byte()
) As Integer
protected:
int Get(
String^ Name,
String^ Mime,
Stream^ Stream,
array<unsigned char>^ AppParams
)
Parameters
- Name String
- The object's name. If the parameter is an empty
string the Name is ignored.
- Mime String
- The object's MIME type. If the parameter is an empty
string the Mime is ignored.
- Stream Stream
- The object's data stream. This must be valid
empty stream object. The stream must have write access
permission.
- AppParams Byte
- The application parameters raw bytes.
Return Value
Int32 If the function succeed 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 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.
See Also