Share via


IStream::UnlockRegion

This method removes the access restriction on a range of bytes previously restricted with IStream::LockRegion.

HRESULT UnlockRegion( 
ULARGE_INTEGER libOffset, 
ULARGE_INTEGER cb, 
DWORD dwLockType 
);

Parameters

  • libOffset
    [in] Specifies the byte offset for the beginning of the range.
  • cb
    [in] Specifies, in bytes, the length of the range to be restricted.
  • dwLockType
    [in] Specifies the access restrictions previously placed on the range.

Return Values

One of the values described in the following table is returned.

Value Description
S_OK The byte range was unlocked.
E_PENDING Asynchronous Storage only: Part or all of the streams data is currently unavailable.
STG_E_INVALIDFUNCTION Locking is not supported at all or the specific type of lock requested is not supported.
STG_E_LOCKVIOLATION The requested unlock cannot be granted.
STG_E_REVERTED The object has been invalidated by a revert operation above it in the transaction tree.

Remarks

IStream::UnlockRegion unlocks a region previously locked with the IStream::LockRegion method. Locked regions must later be explicitly unlocked by calling IStream::UnlockRegion with exactly the same values for the libOffset, cb, and dwLockType parameters. The region must be unlocked before the stream is released. Two adjacent regions cannot be locked separately and then unlocked with a single unlock call.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Objidl.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.