diff options
| author | Russell Yanofsky <russ@yanofsky.org> | 2019-01-31 17:48:51 -0500 |
|---|---|---|
| committer | Russell Yanofsky <russ@yanofsky.org> | 2019-02-01 13:05:30 -0500 |
| commit | a8d645c934ff878773332c34347ba2d91b4dee05 (patch) | |
| tree | 27d5e084734e84e264d9549c926875199815e857 /src/wallet | |
| parent | 95a812b5993afe69bfe0fd796428b98ab6282e66 (diff) | |
| download | bitcoin-a8d645c934ff878773332c34347ba2d91b4dee05.tar.xz | |
Update ScanForWalletTransactions result comment
Suggested https://github.com/bitcoin/bitcoin/pull/14711#discussion_r252038666
Diffstat (limited to 'src/wallet')
| -rw-r--r-- | src/wallet/wallet.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp index 784cb51cc2..deb4289f17 100644 --- a/src/wallet/wallet.cpp +++ b/src/wallet/wallet.cpp @@ -1622,10 +1622,11 @@ int64_t CWallet::RescanFromTime(int64_t startTime, const WalletRescanReserver& r * @param[in] stop_block if not null, the scan will stop at this block instead * of the chain tip * - * @return ScanResult indicating success or failure of the scan. SUCCESS if - * scan was successful. FAILURE if a complete rescan was not possible (due to - * pruning or corruption). USER_ABORT if the rescan was aborted before it - * could complete. + * @return ScanResult returning scan information and indicating success or + * failure. Return status will be set to SUCCESS if scan was + * successful. FAILURE if a complete rescan was not possible (due to + * pruning or corruption). USER_ABORT if the rescan was aborted before + * it could complete. * * @pre Caller needs to make sure start_block (and the optional stop_block) are on * the main chain after to the addition of any new keys you want to detect |