SetClassLongA 函式 (winuser.h)

發行項
07/21/2023

將指定的 32 位 (長) 值取代為指定視窗所屬類別的額外類別記憶體或 WNDCLASSEX 結構。

注意SetClassLongPtr函式已取代此函式。若要撰寫與 32 位和 64 位版本的 Windows 相容的程式碼，請使用 SetClassLongPtr。

語法

DWORD SetClassLongA(
  [in] HWND hWnd,
  [in] int  nIndex,
  [in] LONG dwNewLong
);

參數

[in] hWnd

類型： HWND

視窗的控制碼，以及間接屬於視窗所屬的類別。

[in] nIndex

類型： int

要取代的值。若要在額外的類別記憶體中設定 32 位值，請指定要設定之值的正位元組位移、以零起始的位移。有效值的範圍是零到額外類別記憶體的位元組數目減四;例如，如果您指定了 12 個以上的額外類別記憶體位元組，則 8 的值會是第三個 32 位整數的索引。若要設定 WNDCLASSEX 結構的任何其他值，請指定下列其中一個值。

值	意義
GCL_CBCLSEXTRA -20	設定與類別相關聯之額外記憶體的大小，以位元組為單位。設定此值並不會變更已配置的額外位元組數目。
GCL_CBWNDEXTRA -18	設定與類別中每個視窗相關聯的額外視窗記憶體大小，以位元組為單位。設定此值並不會變更已配置的額外位元組數目。如需如何存取此記憶體的詳細資訊，請參閱 SetWindowLong。
GCL_HBRBACKGROUND -10	取代與類別相關聯之背景筆刷的控制碼。
GCL_HCURSOR -12	取代與類別相關聯之資料指標的控制碼。
GCL_HICON -14	取代與類別相關聯之圖示的控制碼。
GCL_HICONSM -34	將控制碼取代為與類別相關聯的小型圖示。
GCL_HMODULE -16	取代註冊類別之模組的控制碼。
GCL_MENUNAME -8	取代功能表名稱字串的位址。字串會識別與類別相關聯的功能表資源。
GCL_STYLE -26	取代視窗類別樣式位。
GCL_WNDPROC -24	取代與類別相關聯的視窗程式位址。

[in] dwNewLong

類型： LONG

替代值。

傳回值

類型： DWORD

如果函式成功，則傳回值是指定之 32 位整數的先前值。如果先前未設定值，則傳回值為零。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果您使用 SetClassLong 函式和 GCL_WNDPROC 索引來取代視窗程式，則視窗程式必須符合 WindowProc 回呼函式描述中指定的指導方針。

使用GCL_WNDPROC索引呼叫SetClassLong會建立視窗類別的子類別，影響後續使用類別建立的所有視窗。應用程式可以將系統類別子類別化，但不應該將另一個進程所建立的視窗類別子類別子類別。

在搭配RegisterClassEx函式使用的WNDCLASSEX結構之 cbClsExtra成員中指定非零值，以保留額外的類別記憶體。

請小心使用 SetClassLong 函式。例如，您可以使用 SetClassLong來變更類別的背景色彩，但這項變更不會立即重新繪製屬於類別的所有視窗。

範例

如需範例，請參閱顯示圖示。

注意

winuser.h 標頭會將 SetClassLong 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求


最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平台	Windows
標頭	winuser.h (包含 Windows.h)
程式庫	User32.lib
Dll	User32.dll
API 集合	ext-ms-win-ntuser-windowclass-l1-1-2 (Windows 10 10.0.10240 版)