[#BloombergLP-bslmt-WriteLockGuard]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslmt.adoc[bslmt]::WriteLockGuard
:relfileprefix: ../../
:mrdocs:

This class template implements a guard for acquisition and release of write synchronization resources (i.e., writer locks).

== Synopsis

Declared in `<bslmt_writelockguard.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class T>
class WriteLockGuard;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/WriteLockGuard/2constructor-02.adoc[`WriteLockGuard`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslmt/WriteLockGuard/2destructor.adoc[`~WriteLockGuard`] [.small]#[destructor]#
| Destroy this scoped guard and invoke the `unlock` method on the lock object under management by this guard, if any. If no lock is currently being managed, this method has no effect.
| xref:BloombergLP/bslmt/WriteLockGuard/ptr.adoc[`ptr`] 
| Return the address of the modifiable lock object under management by this guard, or 0 if no lock is currently being managed.
| xref:BloombergLP/bslmt/WriteLockGuard/release.adoc[`release`] 
| Return the address of the modifiable lock object under management by this guard, and release the lock from further management by this guard. If no lock is currently being managed, return 0 with no other effect. Note that this operation does _not_ unlock the lock object (if any) that was under management.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslmt/LockWriteGuard.adoc[`LockWriteGuard`] 
| DEPRECATED: Use `WriteLockGuard` instead.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#