windows_programming_notes.nbk: Home | Index | Next Page: LOGBRUSH | Previous Page: LoadResource

 LockResource

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. Note that this parameter is listed as an HGLOBAL variable only for backward 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 or FindResourceEx function. Such a handle points to random data.

Function Information

• Minimum DLL Version kernel32.dll
• Header Declared in Winbase.h, include Windows.h
• Import library Kernel32.lib
• Minimum operating systems Windows 95, Windows NT 3.1
• Unicode Implemented as Unicode version.

windows_programming_notes.nbk: Home | Index | Next Page: LOGBRUSH | Previous Page: LoadResource

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time