SyncLockWithStatusT::GetStatus Method
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at SyncLockWithStatusT::GetStatus Method.
Supports the WRL infrastructure and is not intended to be used directly from your code.
Syntax
DWORD GetStatus() const;
Return Value
The result of a wait operation on the object that is based on the SyncLockWithStatusT class, such as a Mutex or Semaphore. Zero (0) indicates the wait operation returned the signaled state; otherwise, another state occurred, such as time-out value elapsed.
Remarks
Retrieves the wait status of the current SyncLockWithStatusT object.
The GetStatus() function retrieves the value of the underlying status_ data member. When an object based on the SyncLockWithStatusT class performs a lock operation, the object first waits for the object to become available. The result of that wait operation is stored in the status_ data member. The possible values of the status_ data member are the return values of the wait operation. For more information, see the return values of the WaitForSingleObjectEx() function in the MSDN Library.
Requirements
Header: corewrappers.h
Namespace: Microsoft::WRL::Wrappers::Details