Address issue 2239 in WRL docs ComPtr::Reset

Colin Robertson · Colin Robertson · commit e123ba0402d0 · 2020-06-02T15:54:55.000-07:00
diff --git a/docs/cppcx/wrl/comptr-class.md b/docs/cppcx/wrl/comptr-class.md
@@ -1,6 +1,6 @@
 ---
 title: "ComPtr Class"
-ms.date: "07/26/2019"
+ms.date: "06/02/2020"
 ms.topic: "reference"
 f1_keywords: ["client/Microsoft::WRL::ComPtr", "client/Microsoft::WRL::ComPtr::As", "client/Microsoft::WRL::ComPtr::AsIID", "client/Microsoft::WRL::ComPtr::AsWeak", "client/Microsoft::WRL::ComPtr::Attach", "client/Microsoft::WRL::ComPtr::ComPtr", "client/Microsoft::WRL::ComPtr::CopyTo", "client/Microsoft::WRL::ComPtr::Detach", "client/Microsoft::WRL::ComPtr::Get", "client/Microsoft::WRL::ComPtr::GetAddressOf", "client/Microsoft::WRL::ComPtr::InternalAddRef", "client/Microsoft::WRL::ComPtr::InternalRelease", "client/Microsoft::WRL::ComPtr::operator&", "client/Microsoft::WRL::ComPtr::operator->", "client/Microsoft::WRL::ComPtr::operator=", "client/Microsoft::WRL::ComPtr::operator==", "client/Microsoft::WRL::ComPtr::operator!=", "client/Microsoft::WRL::ComPtr::operator Microsoft::WRL::Details::BoolType", "client/Microsoft::WRL::ComPtr::ptr_", "client/Microsoft::WRL::ComPtr::ReleaseAndGetAddressOf", "client/Microsoft::WRL::ComPtr::Reset", "client/Microsoft::WRL::ComPtr::Swap", "client/Microsoft::WRL::ComPtr::~ComPtr"]
 helpviewer_keywords: ["Microsoft::WRL::ComPtr class", "Microsoft::WRL::ComPtr::As method", "Microsoft::WRL::ComPtr::AsIID method", "Microsoft::WRL::ComPtr::AsWeak method", "Microsoft::WRL::ComPtr::Attach method", "Microsoft::WRL::ComPtr::ComPtr, constructor", "Microsoft::WRL::ComPtr::CopyTo method", "Microsoft::WRL::ComPtr::Detach method", "Microsoft::WRL::ComPtr::Get method", "Microsoft::WRL::ComPtr::GetAddressOf method", "Microsoft::WRL::ComPtr::InternalAddRef method", "Microsoft::WRL::ComPtr::InternalRelease method", "Microsoft::WRL::ComPtr::operator& operator", "Microsoft::WRL::ComPtr::operator-> operator", "Microsoft::WRL::ComPtr::operator= operator", "Microsoft::WRL::ComPtr::operator== operator", "Microsoft::WRL::ComPtr::operator!= operator", "Microsoft::WRL::ComPtr::operator Microsoft::WRL::Details::BoolType operator", "Microsoft::WRL::ComPtr::ptr_ data member", "Microsoft::WRL::ComPtr::ReleaseAndGetAddressOf method", "Microsoft::WRL::ComPtr::Reset method", "Microsoft::WRL::ComPtr::Swap method", "Microsoft::WRL::ComPtr::~ComPtr, destructor"]
@@ -32,7 +32,7 @@ A class to which the current `ComPtr` is a friend. (The template that uses this
 
 `ComPtr<>` declares a type that represents the underlying interface pointer. Use `ComPtr<>` to declare a variable and then use the arrow member-access operator (`->`) to access an interface member function.
 
-For more information about smart pointers, see the "COM Smart Pointers" subsection of the [COM Coding Practices](/windows/win32/LearnWin32/com-coding-practices) topic in the MSDN Library.
+For more information about smart pointers, see the "COM Smart Pointers" subsection of the [COM Coding Practices](/windows/win32/LearnWin32/com-coding-practices) article in the MSDN Library.
 
 ## Members
 
@@ -46,7 +46,7 @@ Name            | Description
 
 Name                             | Description
 -------------------------------- | --------------------------------------------------------------------------------------------------------------------
-[ComPtr::ComPtr](#comptr)        | Intializes a new instance of the `ComPtr` class. Overloads provide default, copy, move, and conversion constructors.
+[ComPtr::ComPtr](#comptr)        | Initializes a new instance of the `ComPtr` class. Overloads provide default, copy, move, and conversion constructors.
 [ComPtr::~ComPtr](#tilde-comptr) | Deinitializes an instance of `ComPtr`.
 
 ### Public Methods
@@ -62,7 +62,7 @@ Name                                                      | Description
 [ComPtr::Get](#get)                                       | Retrieves a pointer to the interface that is associated with this `ComPtr`.
 [ComPtr::GetAddressOf](#getaddressof)                     | Retrieves the address of the [ptr_](#ptr) data member, which contains a pointer to the interface represented by this `ComPtr`.
 [ComPtr::ReleaseAndGetAddressOf](#releaseandgetaddressof) | Releases the interface associated with this `ComPtr` and then retrieves the address of the [ptr_](#ptr) data member, which contains a pointer to the interface that was released.
-[ComPtr::Reset](#reset)                                   | Releases all references for the pointer to the interface that is associated with this `ComPtr`.
+[ComPtr::Reset](#reset)                                   | Releases the interface associated with this `ComPtr` and returns the new reference count.
 [ComPtr::Swap](#swap)                                     | Exchanges the interface managed by the current `ComPtr` with the interface managed by the specified `ComPtr`.
 
 ### Protected Methods
@@ -80,8 +80,8 @@ Name
 [ComPtr::operator->](#operator-arrow)                                                          | Retrieves a pointer to the type specified by the current template parameter.
 [ComPtr::operator=](#operator-assign)                                                          | Assigns a value to the current `ComPtr`.
 [ComPtr::operator==](#operator-equality)                                                       | Indicates whether two `ComPtr` objects are equal.
-[ComPtr::operator!=](#operator-inequality)                                                     | Indicates whether two `ComPtr` objects are not equal.
-[ComPtr::operator Microsoft::WRL::Details::BoolType](#operator-microsoft-wrl-details-booltype) | Indicates whether or not a `ComPtr` is managing the object lifetime of an interface.
+[ComPtr::operator!=](#operator-inequality)                                                     | Indicates whether two `ComPtr` objects aren't equal.
+[ComPtr::operator Microsoft::WRL::Details::BoolType](#operator-microsoft-wrl-details-booltype) | Indicates whether a `ComPtr` is managing the object lifetime of an interface.
 
 ### Protected Data Members
 
@@ -133,7 +133,7 @@ A `ComPtr` object that represents the interface specified by parameter *U*. Para
 
 ### Remarks
 
-The first template is the form that you should use in your code. The second template is an internal, helper specialization that supports C++ language features such as the [auto](../../cpp/auto-cpp.md) type deduction keyword.
+The first template is the form that you should use in your code. The second template is an internal, helper specialization. It supports C++ language features such as the [auto](../../cpp/auto-cpp.md) type deduction keyword.
 
 ### Return Value
 
@@ -156,7 +156,7 @@ WRL_NOTHROW HRESULT AsIID(
 An interface ID.
 
 *p*<br/>
-If the object has an interface whose ID equals *riid*, a doubly-indirect pointer to the interface specified by the *riid* parameter; otherwise, a pointer to `IUnknown`.
+If the object has an interface whose ID equals *riid*, a doubly indirect pointer to the interface specified by the *riid* parameter. Otherwise, a pointer to `IUnknown`.
 
 ### Return Value
 
@@ -198,7 +198,7 @@ An interface type.
 
 ## <a name="comptr"></a> ComPtr::ComPtr
 
-Intializes a new instance of the `ComPtr` class. Overloads provide default, copy, move, and conversion constructors.
+Initializes a new instance of the `ComPtr` class. Overloads provide default, copy, move, and conversion constructors.
 
 ```cpp
 WRL_NOTHROW ComPtr();
@@ -244,13 +244,13 @@ An object of type *U*.
 
 ### Remarks
 
-The first constructor is the default constructor, which implictly creates an empty object. The second constructor specifies [__nullptr](../../extensions/nullptr-cpp-component-extensions.md), which explicitly creates an empty object.
+The first constructor is the default constructor, which implicitly creates an empty object. The second constructor specifies [__nullptr](../../extensions/nullptr-cpp-component-extensions.md), which explicitly creates an empty object.
 
 The third constructor creates an object from the object specified by a pointer. The ComPtr now owns the pointed-to memory and maintains a reference count to it.
 
-The fourth and fifth constructors are copy constructors. The fifth constructor copies an object if it is convertible to the current type.
+The fourth and fifth constructors are copy constructors. The fifth constructor copies an object if it's convertible to the current type.
 
-The sixth and seventh constructors are move constructors. The seventh constructor moves an object if it is convertible to the current type.
+The sixth and seventh constructors are move constructors. The seventh constructor moves an object if it's convertible to the current type.
 
 ## <a name="copyto"></a> ComPtr::CopyTo
 
@@ -349,7 +349,7 @@ This method is protected.
 Performs a COM Release operation on the interface associated with this `ComPtr`.
 
 ```cpp
-void InternalRelease();
+unsigned long InternalRelease();
 ```
 
 ### Remarks
@@ -372,7 +372,7 @@ A weak reference to the current `ComPtr`.
 
 ### Remarks
 
-This method differs from [ComPtr::GetAddressOf](#getaddressof) in that this method releases a reference to the interface pointer. Use `ComPtr::GetAddressOf` when you require the address of the interface pointer but do not want to release that interface.
+This method differs from [ComPtr::GetAddressOf](#getaddressof) in that this method releases a reference to the interface pointer. Use `ComPtr::GetAddressOf` when you require the address of the interface pointer but don't want to release that interface.
 
 ## <a name="operator-arrow"></a> ComPtr::operator-&gt;
 
@@ -437,11 +437,11 @@ A reference to the current `ComPtr`.
 
 The first version of this operator assigns an empty value to the current `ComPtr`.
 
-In the second version, if the assigning interface pointer is not the same as the current `ComPtr` interface pointer, the second interface pointer is assigned to the current `ComPtr`.
+In the second version, if the assigning interface pointer isn't the same as the current `ComPtr` interface pointer, the second interface pointer is assigned to the current `ComPtr`.
 
 In the third version, the assigning interface pointer is assigned to the current `ComPtr`.
 
-In the fourth version, if the interface pointer of the assigning value is not the same as the current `ComPtr` interface pointer, the second interface pointer is assigned to the current `ComPtr`.
+In the fourth version, if the interface pointer of the assigning value isn't the same as the current `ComPtr` interface pointer, the second interface pointer is assigned to the current `ComPtr`.
 
 The fifth version is a copy operator; a reference to a `ComPtr` is assigned to the current `ComPtr`.
 
@@ -486,7 +486,7 @@ The second and third operators yield `true` if object *a* is equal to `nullptr`;
 
 ## <a name="operator-inequality"></a> ComPtr::operator!=
 
-Indicates whether two `ComPtr` objects are not equal.
+Indicates whether two `ComPtr` objects aren't equal.
 
 ```cpp
 bool operator!=(
@@ -515,13 +515,13 @@ A reference to another `ComPtr` object.
 
 ### Return Value
 
-The first operator yields `true` if object *a* is not equal to object *b*; otherwise, `false`.
+The first operator yields `true` if object *a* isn't equal to object *b*; otherwise, `false`.
 
-The second and third operators yield `true` if object *a* is not equal to `nullptr`; otherwise, `false`.
+The second and third operators yield `true` if object *a* isn't equal to `nullptr`; otherwise, `false`.
 
 ## <a name="operator-microsoft-wrl-details-booltype"></a> ComPtr::operator Microsoft::WRL::Details::BoolType
 
-Indicates whether or not a `ComPtr` is managing the object lifetime of an interface.
+Indicates whether a `ComPtr` is managing the object lifetime of an interface.
 
 ```cpp
 WRL_NOTHROW operator Microsoft::WRL::Details::BoolType() const;
@@ -557,15 +557,15 @@ The address of the [ptr_](#ptr) data member of this `ComPtr`.
 
 ## <a name="reset"></a> ComPtr::Reset
 
-Releases all references for the pointer to the interface that is associated with this `ComPtr`.
+Releases the interface associated with this `ComPtr` and returns the new reference count.
 
 ```cpp
 unsigned long Reset();
 ```
 
 ### Return Value
 
-The number of references released, if any.
+The number of references remaining to the underlying interface, if any.
 
 ## <a name="swap"></a> ComPtr::Swap
 
