wclCustomObexClientPut Method |
Sends one object from the client to the server.
Namespace: wclCommunicationAssembly: wclCommunication (in wclCommunication.dll) Version: 7.9.6.0 (7.9.6.0)
Syntaxprotected int Put(
string Name,
string Mime,
string Description,
Stream Stream,
byte[] AppParams
)
Protected Function Put (
Name As String,
Mime As String,
Description As String,
Stream As Stream,
AppParams As Byte()
) As Integer
protected:
int Put(
String^ Name,
String^ Mime,
String^ Description,
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.
- Description String
- The object's description. If the parameter is
an empty string the Description is ignored.
- Stream Stream
- The object's data stream. If the parameter is
null it forces to delete the object with the name specified
by the Name parameter or with MIME type specified by the
Mime parameter. If the Stream parameter is an empty
stream (it is not null and the Stream size is 0)
it forces a server to create an empty object with the given Name or
MIME.
- 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 sending an object (or other operation
described above) to a 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 Put operation the OnProgress
event may (or may not) fire indicating the operation
progress.
See Also