LockResource

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function locks the specified resource in memory.

Syntax

LPVOID LockResource(
  HGLOBAL hResData 
);

Parameters

  • hResData
    [in] Handle to the resource to be locked. The LoadResource function returns this handle. This parameter is listed as an HGLOBAL variable only for backwards compatibility. Do not pass any value as a parameter other than a successful return value from the LoadResource function.

Return Value

If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL.

Remarks

The pointer returned by LockResource is valid until the module containing the resource is unloaded. It is not necessary to unlock resources because the system automatically deletes them when the process that created them terminates.

Do not try to lock a resource by using the handle returned by the FindResource function. Such a handle points to random data.

Requirements

Header winbase.h
Library coredll.lib, Nk.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

FindResource
FindResource

Other Resources

LoadLibrary
FreeLibrary