EngLockSurface function

The EngLockSurface function creates a user object for a given surface. This function gives drivers access to surfaces they create.

Syntax


SURFOBJ* EngLockSurface(
   HSURF hsurf
);

Parameters

hsurf

Handle to the surface to be locked.

Return value

EngLockSurface returns a pointer to a SURFOBJ structure if the function is successful. Otherwise, this function returns NULL.

Remarks

This function gives drivers access to surfaces they create.

The driver is responsible for unlocking the surface when it no longer needs it. Surfaces should be locked only for very short periods of time.

Use the EngUnlockSurface function to unlock the surface.

Requirements

Target platform

Universal

Version

Available in Windows 2000 and later versions of the Windows operating systems.

Header

Winddi.h (include Winddi.h)

Library

Win32k.lib

DLL

Win32k.sys

See also

SURFOBJ
EngUnlockSurface

 

 

Send comments about this topic to Microsoft

Show: