SetClassLongPtrA 函数 (winuser.h)

在额外的类内存或 WNDCLASSEX 结构中替换指定值(位于指定窗口所属的类)中的指定偏移量。

注释 若要编写与 32 位和 64 位 Windows 兼容的代码,请使用 SetClassLongPtr。 编译 32 位 Windows 时,SetClassLongPtr 定义为对 SetClassLong 函数的调用

 

语法

ULONG_PTR SetClassLongPtrA(
  [in] HWND     hWnd,
  [in] int      nIndex,
  [in] LONG_PTR dwNewLong
);

参数

[in] hWnd

类型:HWND

窗口的句柄,间接地是窗口所属的类。

[in] nIndex

类型:int

要替换的值。 若要在额外的类内存中设置值,请指定要设置的值的正、从零开始的字节偏移量。 有效值为零到额外类内存的字节数(减 8);例如,如果指定了 24 个或更多字节的额外类内存,则值 16 将是第三个整数的索引。 若要设置除 WNDCLASSEX 结构以外的值,请指定以下值之一。

价值 意义
GCL_CBCLSEXTRA
-20
设置与类关联的额外内存的大小(以字节为单位)。 设置此值不会更改已分配的额外字节数。
GCL_CBWNDEXTRA
-18
设置与类中每个窗口关联的额外窗口内存的大小(以字节为单位)。 设置此值不会更改已分配的额外字节数。 有关如何访问此内存的信息,请参阅 SetWindowLongPtr
GCLP_ HBRBACKGROUND
-10
替换与类关联的背景画笔的句柄。
GCLP_HCURSOR
-12
替换与类关联的游标的句柄。
GCLP_HICON
-14
替换与类关联的图标的句柄。
GCLP_HICONSM
-34
检索与类关联的小图标的句柄。
GCLP_HMODULE
-16
替换注册类的模块的句柄。
GCLP_MENUNAME
-8
替换指向菜单名称字符串的指针。 该字符串标识与类关联的菜单资源。
GCL_STYLE
-26
替换窗口类样式位。
GCLP_WNDPROC
-24
替换指向与类关联的窗口过程的指针。

[in] dwNewLong

类型:LONG_PTR

替换值。

返回值

类型:ULONG_PTR

如果函数成功,则返回值为指定偏移量的上一个值。 如果未设置此值,则返回值为零。

如果函数失败,则返回值为零。 若要获取扩展的错误信息,请调用 GetLastError

言论

如果使用 SetClassLongPtr 函数和 GCLP_WNDPROC 索引替换窗口过程,则窗口过程必须符合 WindowProc 回调函数的说明中指定的准则。

使用 GCLP_WNDPROC 索引调用 SetClassLongPtr 将创建一个窗口类的子类,该子类会影响随后使用该类创建的所有窗口。 应用程序可以对系统类进行子类,但不应将由另一个进程创建的窗口类子类。

通过在与 RegisterClassEx 函数一起使用的 WNDCLASSEX 结构中的 cbClsExtra 成员中指定非零值来保留额外的类内存。

谨慎使用 SetClassLongPtr 函数。 例如,可以使用 SetClassLongPtr更改类的背景色,但此更改不会立即重新修补属于该类的所有窗口。

注意

winuser.h 标头将 SetClassLongPtr 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows 2000 Professional [仅限桌面应用]
支持的最低服务器 Windows 2000 Server [仅限桌面应用]
目标平台 窗户
标头 winuser.h (包括 Windows.h)
User32.lib
DLL User32.dll
API 集 ext-ms-win-ntuser-windowclass-l1-1-2(在 Windows 10 版本 10.0.10240 中引入)

另请参阅

概念

GetClassLongPtr

参考

RegisterClassEx

SetWindowLongPtr

WNDCLASSEX

窗口类

WindowProc