The IDirectDrawSurface3::PageLock method prevents a system-memory surface from being paged out while a blit operation using direct memory access (DMA) transfers to or from system memory is in progress.
HRESULT PageLock(
DWORD dwFlags
);
Parameters
dwFlags
This parameter is currently not used and must be set to 0.
Return Values
If the method succeeds, the return value is DD_OK.
If the method fails, the return value may be one of the following error values:
| DDERR_CANTPAGELOCK |
| DDERR_INVALIDOBJECT |
| DDERR_INVALIDPARAMS |
| DDERR_SURFACELOST |
Remarks
You must call this method to make use of DMA support. If you do not, the blit occurs using software emulation. For more information, see Using DMA.
The performance of the operating system could be negatively affected if too much memory is locked.
A lock count is maintained for each surface and is incremented each time IDirectDrawSurface3::PageLock is called for that surface. The count is decremented when IDirectDrawSurface3::PageUnlock is called. When the count reaches 0, the memory is unlocked and can then be paged by the operating system.
This method works only on system-memory surfaces; it will not page lock a display-memory surface or an emulated primary surface. If an application calls this method on a display memory surface, the method will do nothing except return DD_OK.
This method was not implemented in the IDirectDraw interface.
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in ddraw.h.
Import Library: Use ddraw.lib.
See Also
IDirectDrawSurface3::PageUnlock