Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify destruction of SRW locks and condition variables. #447

Merged
merged 4 commits into from
Sep 14, 2020
Merged

Clarify destruction of SRW locks and condition variables. #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4a4cc3
Clarify destruction of SRW locks.
m-ou-se Sep 12, 2020
1490b46
Clarify destruction of condition variables.
m-ou-se Sep 12, 2020
afd80fb
Update nf-synchapi-initializeconditionvariable.md
Karl-Bridge-Microsoft Sep 14, 2020
722cbf5
Update nf-synchapi-initializesrwlock.md
Karl-Bridge-Microsoft Sep 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion sdk-api-src/content/synchapi/nf-synchapi-initializeconditionvariable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ Threads can atomically release a lock and enter the sleeping state using the <a

Condition variables are user-mode objects that cannot be shared across processes.

A condition variable cannot be moved or copied. The process must not modify the object, and must instead treat it as logically opaque. Only use the condition variable functions to manage condition variables.
A condition variable cannot be moved or copied while in use. The process must not modify the object, and must instead treat it as logically opaque. Only use the condition variable functions to manage condition variables.

A condition variable with no waiting threads is in its initial state and can be copied, moved, and forgotten without being explicitly destroyed.

#### Examples

Expand Down
4 changes: 2 additions & 2 deletions sdk-api-src/content/synchapi/nf-synchapi-initializesrwlock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ A pointer to the SRW lock.

An SRW lock must be initialized before it is used. The InitializeSRWLock function is used to initialize a SRW lock dynamically. To initialize the structure statically, assign the constant <b>SRWLOCK_INIT</b> to the structure variable.

An SRW lock cannot be moved or copied. The process must not modify the object, and must instead treat it as logically opaque. Only use the SRW functions to manage SRW locks.
An SRW lock cannot be moved or copied while in use. The process must not modify the object, and must instead treat it as logically opaque. Only use the SRW functions to manage SRW locks.

SRW locks do not need to be explicitly destroyed.
An unlocked SRW lock with no waiting threads is in its initial state and can be copied, moved, and forgotten without being explicitly destroyed.

## -see-also

Expand Down