ILockBytes::UnlockRegion

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

At a Glance

Header file: Objbase.h
Windows CE versions: 2.0 and later

Syntax

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 that is restricted.

dwLockType

[in] Specifies the type of access restrictions previously placed on the range. This parameter uses a value from the LOCKTYPE enumeration.

Return Values

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

Value Description
S_OK The byte range was unlocked.
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.

Remarks

ILockBytes::UnlockRegion unlocks a region previously locked with a call to ILockBytes::LockRegion. Each region locked must be explicitly unlocked, using the same values for the libOffset, cb, and dwLockType parameters as in the matching calls to ILockBytes::LockRegion. Two adjacent regions cannot be locked separately and then unlocked with a single unlock call.