Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
170 lines (111 loc) · 5.39 KB

srwlock-class.md

File metadata and controls

170 lines (111 loc) · 5.39 KB
description title ms.date ms.topic f1_keywords helpviewer_keywords ms.assetid
Learn more about: SRWLock Class
SRWLock Class
09/25/2018
reference
corewrappers/Microsoft::WRL::Wrappers::SRWLock
corewrappers/Microsoft::WRL::Wrappers::SRWLock::LockExclusive
corewrappers/Microsoft::WRL::Wrappers::SRWLock::LockShared
corewrappers/Microsoft::WRL::Wrappers::SRWLock::SRWLock
corewrappers/Microsoft::WRL::Wrappers::SRWLock::SRWLock_
corewrappers/Microsoft::WRL::Wrappers::SRWLock::~SRWLock
corewrappers/Microsoft::WRL::Wrappers::SRWLock::TryLockExclusive
corewrappers/Microsoft::WRL::Wrappers::SRWLock::TryLockShared
Microsoft::WRL::Wrappers::SRWLock class
Microsoft::WRL::Wrappers::SRWLock::LockExclusive method
Microsoft::WRL::Wrappers::SRWLock::LockShared method
Microsoft::WRL::Wrappers::SRWLock::SRWLock, constructor
Microsoft::WRL::Wrappers::SRWLock::SRWLock_ data member
Microsoft::WRL::Wrappers::SRWLock::~SRWLock, destructor
Microsoft::WRL::Wrappers::SRWLock::TryLockExclusive method
Microsoft::WRL::Wrappers::SRWLock::TryLockShared method
4fa250e3-5f29-4b06-ac24-61b6c04ade93

SRWLock Class

Represents a slim reader/writer lock.

Syntax

class SRWLock;

Remarks

A slim reader/writer lock is used to synchronize access across threads to an object or resource. For more information, see Synchronization Functions.

Members

Public Typedefs

Name Description
SyncLockExclusive Synonym for an SRWLock object that is acquired in exclusive mode.
SyncLockShared Synonym for an SRWLock object that is acquired in shared mode.

Public Constructors

Name Description
SRWLock::SRWLock Initializes a new instance of the SRWLock class.
SRWLock::~SRWLock Deinitializes an instance of the SRWLock class.

Public Methods

Name Description
SRWLock::LockExclusive Acquires an SRWLock object in exclusive mode.
SRWLock::LockShared Acquires an SRWLock object in shared mode.
SRWLock::TryLockExclusive Attempts to acquire a SRWLock object in exclusive mode for the current or specified SRWLock object.
SRWLock::TryLockShared Attempts to acquire a SRWLock object in shared mode for the current or specified SRWLock object.

Protected Data Member

Name Description
SRWLock::SRWLock_ Contains the underlying lock variable for the current SRWLock object.

Inheritance Hierarchy

SRWLock

Requirements

Header: corewrappers.h

Namespace: Microsoft::WRL::Wrappers

SRWLock::~SRWLock

Deinitializes an instance of the SRWLock class.

~SRWLock();

SRWLock::LockExclusive

Acquires an SRWLock object in exclusive mode.

SyncLockExclusive LockExclusive();

static SyncLockExclusive LockExclusive(
   _In_ SRWLOCK* lock
);

Parameters

lock
Pointer to an SRWLock object.

Return Value

An SRWLock object in exclusive mode.

SRWLock::LockShared

Acquires an SRWLock object in shared mode.

SyncLockShared LockShared();

static SyncLockShared LockShared(
   _In_ SRWLOCK* lock
);

Parameters

lock
Pointer to an SRWLock object.

Return Value

An SRWLock object in shared mode.

SRWLock::SRWLock

Initializes a new instance of the SRWLock class.

SRWLock();

SRWLock::SRWLock_

Contains the underlying lock variable for the current SRWLock object.

SRWLOCK SRWLock_;

SRWLock::TryLockExclusive

Attempts to acquire a SRWLock object in exclusive mode for the current or specified SRWLock object. If the call is successful, the calling thread takes ownership of the lock.

SyncLockExclusive TryLockExclusive();

static SyncLockExclusive TryLockExclusive(
   _In_ SRWLOCK* lock
);

Parameters

lock
Pointer to an SRWLock object.

Return Value

If successful, an SRWLock object in exclusive mode and the calling thread takes ownership of the lock. Otherwise, an SRWLock object whose state is invalid.

SRWLock::TryLockShared

Attempts to acquire a SRWLock object in shared mode for the current or specified SRWLock object.

WRL_NOTHROW SyncLockShared TryLockShared();
WRL_NOTHROW static SyncLockShared TryLockShared(
   _In_ SRWLOCK* lock
);

Parameters

lock
Pointer to an SRWLock object.

Return Value

If successful, an SRWLock object in shared mode and the calling thread takes ownership of the lock. Otherwise, an SRWLock object whose state is invalid.