summaryrefslogtreecommitdiff
path: root/src/bluetooth/qbluetoothtransfermanager.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/bluetooth/qbluetoothtransfermanager.cpp')
-rw-r--r--src/bluetooth/qbluetoothtransfermanager.cpp14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/bluetooth/qbluetoothtransfermanager.cpp b/src/bluetooth/qbluetoothtransfermanager.cpp
index 0897465d..65eecae3 100644
--- a/src/bluetooth/qbluetoothtransfermanager.cpp
+++ b/src/bluetooth/qbluetoothtransfermanager.cpp
@@ -52,7 +52,10 @@ QT_BEGIN_NAMESPACE
\since 5.2
- QBluetoothTransferManager uses OBEX to send put commands to remote devices.
+ QBluetoothTransferManager uses OBEX to send put commands to remote devices. A typical
+ OBEX transfer is initialized as follows:
+
+ \snippet doc_src_qtbluetooth.cpp sendfile
Note that this API is not currently supported on Android.
*/
@@ -61,7 +64,14 @@ QT_BEGIN_NAMESPACE
\fn QBluetoothTransferReply *QBluetoothTransferManager::put(const QBluetoothTransferRequest &request, QIODevice *data)
Sends the contents of \a data to the remote device identified by \a request, and returns a new
- QBluetoothTransferReply that can be used to track the request's progress.
+ QBluetoothTransferReply that can be used to track the request's progress. \a data must remain valid
+ until the \l finished() signal is emitted.
+
+ The returned \l QBluetoothTransferReply object must be immediately checked for its
+ \l {QBluetoothTransferReply::error()}{error()} state. This is required in case
+ this function detects an error during the initialization of the
+ \l QBluetoothTransferReply. In such cases \l {QBluetoothTransferReply::isFinished()} returns
+ \c true as well.
If the platform does not support the Object Push profile, this function will return \c 0.
*/