LockSegment

2.x

  HGLOBAL LockSegment(uSegment)    
  UINT uSegment; /* segment to lock, */  

The LockSegment function locks the specified discardable segment. The segment is locked into memory at the given address and its lock count is incremented (increased by one).

Parameters

uSegment

Specifies the segment address of the segment to be locked. If this parameter is –1, the LockSegment function locks the current data segment.

Return Value

The return value specifies the data segment if the function is successful. It is NULL if the segment has been discarded or an error occurs.

Comments

Locked memory is not subject to discarding except when a portion of the segment is being reallocated by the GlobalReAlloc function. The segment remains locked in memory until its lock count is decreased to zero by the UnlockSegment function.

Each time an application calls LockSegment for a segment, it must eventually call UnlockSegment for the segment. The UnlockSegment function decrements the lock count for the segment. Other functions also can affect the lock count of a memory object. For a list of these functions, see the description of the GlobalFlags function.

See Also

GlobalFlags, GlobalReAlloc, LockData, UnlockSegment