Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITextStoreACPSink::OnLockGranted method

Syntax


HRESULT OnLockGranted(
  [in] DWORD dwLockFlags
);

Parameters

dwLockFlags [in]

Contains a set of flags that identify the type of lock requested and other lock request data. This can be one of the following values.

ValueMeaning
TS_LF_READ

The lock is read-only.

TS_LF_READWRITE

The lock is read/write.

 

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_INVALIDARG

dwLockFlags is invalid.

E_UNEXPECTED

The wrong type of lock was granted.

 

Remarks

A document lock is requested by calling ITextStoreACP::RequestLock . The application grants the lock request by calling ITextStoreACPSink::OnLockGranted with the requested lock type. The lock is only valid during the OnLockGranted call. When OnLockGranted returns, the document is considered unlocked.

The lock type, specified in dwLockFlags, must match the requested lock type in the corresponding call to ITextStoreACP::RequestLock.

If a synchronous lock request is made from within ITextStoreACP::RequestLock, then the caller must also provide the return value from ITextStoreACP::RequestLock.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Textstor.h

IDL

Textstor.idl

DLL

Msctf.dll

See also

ITextStoreACPSink
Document Locks
ITextStoreACP::RequestLock
TS_LF_* Constants

 

 

Show:
© 2017 Microsoft