Skip to content

Latest commit

 

History

History
83 lines (65 loc) · 3.49 KB

nf-objidl-idirectwriterlock-waitforwriteaccess.md

File metadata and controls

83 lines (65 loc) · 3.49 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:objidl.IDirectWriterLock.WaitForWriteAccess
IDirectWriterLock::WaitForWriteAccess (objidl.h)
The WaitForWriteAccess method obtains exclusive write access to a storage object.
IDirectWriterLock interface [Structured Storage]
WaitForWriteAccess method
IDirectWriterLock.WaitForWriteAccess
IDirectWriterLock::WaitForWriteAccess
WaitForWriteAccess
WaitForWriteAccess method [Structured Storage]
WaitForWriteAccess method [Structured Storage]
IDirectWriterLock interface
_stg_idirectwriterlock_waitforwriteaccess
objidl/IDirectWriterLock::WaitForWriteAccess
stg.idirectwriterlock_waitforwriteaccess
stg\idirectwriterlock_waitforwriteaccess.htm
Stg
e4505bed-325b-494e-93bd-7bf23b3a1215
12/05/2018
IDirectWriterLock interface [Structured Storage],WaitForWriteAccess method, IDirectWriterLock.WaitForWriteAccess, IDirectWriterLock::WaitForWriteAccess, WaitForWriteAccess, WaitForWriteAccess method [Structured Storage], WaitForWriteAccess method [Structured Storage],IDirectWriterLock interface, _stg_idirectwriterlock_waitforwriteaccess, objidl/IDirectWriterLock::WaitForWriteAccess, stg.idirectwriterlock_waitforwriteaccess
objidl.h
Windows
Windows 2000 Professional [desktop apps \| UWP apps]
Windows 2000 Server [desktop apps \| UWP apps]
Objidl.idl
Uuid.lib
Ole32.dll
Windows
19H1
IDirectWriterLock::WaitForWriteAccess
objidl/IDirectWriterLock::WaitForWriteAccess
c++
APIRef
kbSyntax
COM
Ole32.dll
IDirectWriterLock.WaitForWriteAccess

IDirectWriterLock::WaitForWriteAccess

-description

The WaitForWriteAccess method obtains exclusive write access to a storage object.

-parameters

-param dwTimeout [in]

Specifies the time in milliseconds that this method blocks while waiting to obtain exclusive write access to the storage object. If dwTimeout is zero, the method does not block waiting for exclusive access for writing. The INFINITE time-out defined in the Platform SDK is allowed for dwTimeout.

-returns

This method can return one of these values.

Return code Description
S_OK The caller has successfully obtained exclusive write access to the storage.
S_FALSE This method was called again without an intervening call to IDirectWriterLock::ReleaseWriteAccess.
STG_E_INUSE The specified time-out expired without obtaining exclusive write access.

-remarks

When a storage is opened in direct mode (STGM_DIRECT) with the STGM_READWRITE|STGM_SHARE_DENY_WRITE, you can call this method to obtain exclusive write access to the storage.

This method returns immediately if no readers have the storage open. If the storage is still open for reading, this method blocks for the specified dwTimeout or until the current readers close the storage.

-see-also

IDirectWriterLock::HaveWriteAccess

IDirectWriterLock::ReleaseWriteAccess