Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 5df692b

Browse files
rahuldutta90vinjiang
authored andcommitted
Fix the documentation and the variable name
1 parent c73fde9 commit 5df692b

File tree

1 file changed

+11
-10
lines changed
  • Microsoft.WindowsAzure.Storage/includes/was

1 file changed

+11
-10
lines changed

Microsoft.WindowsAzure.Storage/includes/was/core.h

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,9 +1203,9 @@ namespace azure { namespace storage {
12031203
/// <param name="last_request_result">The last request result.</param>
12041204
/// <param name="next_location">The next location to retry.</param>
12051205
/// <param name="current_location_mode">The current location mode.</param>
1206-
/// <param name="ex_ptr">Exception Ptr of any exception other than storage_exception</param>
1207-
retry_context(int current_retry_count, request_result last_request_result, storage_location next_location, location_mode current_location_mode, const std::exception_ptr& ex_ptr = nullptr)
1208-
: m_current_retry_count(current_retry_count), m_last_request_result(std::move(last_request_result)), m_next_location(next_location), m_current_location_mode(current_location_mode), m_unhandled_exception(ex_ptr)
1206+
/// <param name="nonstorage_exception">Exception Ptr of any exception other than storage_exception</param>
1207+
retry_context(int current_retry_count, request_result last_request_result, storage_location next_location, location_mode current_location_mode, const std::exception_ptr& nonstorage_exception = nullptr)
1208+
: m_current_retry_count(current_retry_count), m_last_request_result(std::move(last_request_result)), m_next_location(next_location), m_current_location_mode(current_location_mode), m_nonstorage_exception(nonstorage_exception)
12091209
{
12101210
}
12111211

@@ -1250,10 +1250,10 @@ namespace azure { namespace storage {
12501250
}
12511251

12521252
/// <summary>
1253-
/// Gets the exception_ptr of any unhandled exception during the request.
1253+
/// Gets the results of the last request.
12541254
/// Example: WinHttp exceptions for timeout (12002)
12551255
/// </summary>
1256-
/// <returns>An <see cref="std::exception_ptr" /> object that represents the results of the last request.</returns>
1256+
/// <returns>An <see cref="azure::storage::request_result" /> object that represents the results of the last request.</returns>
12571257
const request_result& last_request_result() const
12581258
{
12591259
return m_last_request_result;
@@ -1278,11 +1278,12 @@ namespace azure { namespace storage {
12781278
}
12791279

12801280
/// <summary>
1281-
/// Gets the location mode for subsequent retries.
1281+
/// Gets the exception_ptr of any unhandled nonstorage exception during the request.
1282+
/// Example: WinHttp exceptions for timeout (12002)
12821283
/// </summary>
1283-
/// <returns>The <see cref="azure::storage::location_mode" /> for subsequent retries.</returns>
1284-
const std::exception_ptr& unhandled_exception() const {
1285-
return m_unhandled_exception;
1284+
/// <returns>An <see cref="std::exception_ptr" /> object that represents the nonstorage exception thrown while sending request</returns>
1285+
const std::exception_ptr& nonstorage_exception() const {
1286+
return m_nonstorage_exception;
12861287
}
12871288

12881289
private:
@@ -1291,7 +1292,7 @@ namespace azure { namespace storage {
12911292
request_result m_last_request_result;
12921293
storage_location m_next_location;
12931294
location_mode m_current_location_mode;
1294-
std::exception_ptr m_unhandled_exception;
1295+
std::exception_ptr m_nonstorage_exception;
12951296
};
12961297

12971298
/// <summary>

0 commit comments

Comments
 (0)