GetClassLong function

Retrieves the specified 32-bit (DWORD) value from the WNDCLASSEX structure associated with the specified window.

Note  If you are retrieving a pointer or a handle, this function has been superseded by the GetClassLongPtr function. (Pointers and handles are 32 bits on 32-bit Windows and 64 bits on 64-bit Windows.)

Syntax


DWORD WINAPI GetClassLong(
  _In_  HWND hWnd,
  _In_  int nIndex
);

Parameters

hWnd [in]

Type: HWND

A handle to the window and, indirectly, the class to which the window belongs.

nIndex [in]

Type: int

The value to be retrieved. To retrieve a value from the extra class memory, specify the positive, zero-based byte offset of the value to be retrieved. Valid values are in the range zero through the number of bytes of extra class memory, minus four; for example, if you specified 12 or more bytes of extra class memory, a value of 8 would be an index to the third integer. To retrieve any other value from the WNDCLASSEX structure, specify one of the following values.

ValueMeaning
GCW_ATOM
-32

Retrieves an ATOM value that uniquely identifies the window class. This is the same atom that the RegisterClassEx function returns.

GCL_CBCLSEXTRA
-20

Retrieves the size, in bytes, of the extra memory associated with the class.

GCL_CBWNDEXTRA
-18

Retrieves the size, in bytes, of the extra window memory associated with each window in the class. For information on how to access this memory, see GetWindowLong.

GCL_HBRBACKGROUND
-10

Retrieves a handle to the background brush associated with the class.

GCL_HCURSOR
-12

Retrieves a handle to the cursor associated with the class.

GCL_HICON
-14

Retrieves a handle to the icon associated with the class.

GCL_HICONSM
-34

Retrieves a handle to the small icon associated with the class.

GCL_HMODULE
-16

Retrieves a handle to the module that registered the class.

GCL_MENUNAME
-8

Retrieves the address of the menu name string. The string identifies the menu resource associated with the class.

GCL_STYLE
-26

Retrieves the window-class style bits.

GCL_WNDPROC
-24

Retrieves the address of the window procedure, or a handle representing the address of the window procedure. You must use the CallWindowProc function to call the window procedure.

 

Return value

Type:

Type: DWORD

If the function succeeds, the return value is the requested value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Reserve extra class memory by specifying a nonzero value in the cbClsExtra member of the WNDCLASSEX structure used with the RegisterClassEx function.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

GetClassLongW (Unicode) and GetClassLongA (ANSI)

See also

Reference
GetClassLongPtr
GetWindowLong
RegisterClassEx
SetClassLong
WNDCLASSEX
Conceptual
Window Classes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft