Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › GetClassWord

GetClassWord

関数
ウィンドウクラスの追加メモリからWORD値を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

WORD GetClassWord(
    HWND hWnd,
    INT nIndex
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドル、および間接的にそのウィンドウが属するクラスへのハンドルです。
nIndexINTin

取得する値の 0 から始まるバイトオフセットです。有効な値の範囲は 0 からクラスメモリのバイト数 - 2 までです。たとえば、追加クラスメモリを 10 バイト以上指定した場合、値 8 は 5 番目の 16 ビット整数を示すインデックスになります。次の表に示すように、もう 1 つの有効な値があります。

意味
GCW_ATOM
-32
ウィンドウクラスを一意に識別する ATOM 値を取得します。これは RegisterClass 関数または RegisterClassEx 関数が返すアトムと同じものです。

戻り値の型: WORD

公式ドキュメント

指定したウィンドウが属するウィンドウクラスの追加クラスメモリにおいて、指定したオフセット位置にある 16 ビット (WORD) 値を取得します。

戻り値

型: WORD

関数が成功した場合、戻り値は要求された 16 ビット値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

追加クラスメモリを予約するには、RegisterClass 関数で使用する WNDCLASS 構造体の cbClsExtra メンバーに 0 以外の値を指定します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

WORD GetClassWord(
    HWND hWnd,
    INT nIndex
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern ushort GetClassWord(
    IntPtr hWnd,   // HWND
    int nIndex   // INT
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClassWord(
    hWnd As IntPtr,   ' HWND
    nIndex As Integer   ' INT
) As UShort
End Function
' hWnd : HWND
' nIndex : INT
Declare PtrSafe Function GetClassWord Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal nIndex As Long) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetClassWord = ctypes.windll.user32.GetClassWord
GetClassWord.restype = ctypes.c_ushort
GetClassWord.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_int,  # nIndex : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClassWord = Fiddle::Function.new(
  lib['GetClassWord'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nIndex : INT
  ],
  -Fiddle::TYPE_SHORT)
#[link(name = "user32")]
extern "system" {
    fn GetClassWord(
        hWnd: *mut core::ffi::c_void,  // HWND
        nIndex: i32  // INT
    ) -> u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern ushort GetClassWord(IntPtr hWnd, int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClassWord' -Namespace Win32 -PassThru
# $api::GetClassWord(hWnd, nIndex)
#uselib "USER32.dll"
#func global GetClassWord "GetClassWord" sptr, sptr
; GetClassWord hWnd, nIndex   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; nIndex : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetClassWord "GetClassWord" sptr, int
; res = GetClassWord(hWnd, nIndex)
; hWnd : HWND -> "sptr"
; nIndex : INT -> "int"
; WORD GetClassWord(HWND hWnd, INT nIndex)
#uselib "USER32.dll"
#cfunc global GetClassWord "GetClassWord" intptr, int
; res = GetClassWord(hWnd, nIndex)
; hWnd : HWND -> "intptr"
; nIndex : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetClassWord = user32.NewProc("GetClassWord")
)

// hWnd (HWND), nIndex (INT)
r1, _, err := procGetClassWord.Call(
	uintptr(hWnd),
	uintptr(nIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WORD
function GetClassWord(
  hWnd: THandle;   // HWND
  nIndex: Integer   // INT
): Word; stdcall;
  external 'USER32.dll' name 'GetClassWord';
result := DllCall("USER32\GetClassWord"
    , "Ptr", hWnd   ; HWND
    , "Int", nIndex   ; INT
    , "UShort")   ; return: WORD
●GetClassWord(hWnd, nIndex) = DLL("USER32.dll", "int GetClassWord(void*, int)")
# 呼び出し: GetClassWord(hWnd, nIndex)
# hWnd : HWND -> "void*"
# nIndex : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetClassWord(
    hWnd: ?*anyopaque, // HWND
    nIndex: i32 // INT
) callconv(std.os.windows.WINAPI) u16;
proc GetClassWord(
    hWnd: pointer,  # HWND
    nIndex: int32  # INT
): uint16 {.importc: "GetClassWord", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
ushort GetClassWord(
    void* hWnd,   // HWND
    int nIndex   // INT
);
ccall((:GetClassWord, "USER32.dll"), stdcall, UInt16,
      (Ptr{Cvoid}, Int32),
      hWnd, nIndex)
# hWnd : HWND -> Ptr{Cvoid}
# nIndex : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint16_t GetClassWord(
    void* hWnd,
    int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetClassWord(hWnd, nIndex)
-- hWnd : HWND
-- nIndex : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetClassWord = lib.func('__stdcall', 'GetClassWord', 'uint16_t', ['void *', 'int32_t']);
// GetClassWord(hWnd, nIndex)
// hWnd : HWND -> 'void *'
// nIndex : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetClassWord: { parameters: ["pointer", "i32"], result: "u16" },
});
// lib.symbols.GetClassWord(hWnd, nIndex)
// hWnd : HWND -> "pointer"
// nIndex : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint16_t GetClassWord(
    void* hWnd,
    int32_t nIndex);
C, "USER32.dll");
// $ffi->GetClassWord(hWnd, nIndex);
// hWnd : HWND
// nIndex : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    short GetClassWord(
        Pointer hWnd,   // HWND
        int nIndex   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetClassWord = GetClassWord(
    hWnd : Void*,   # HWND
    nIndex : Int32   # INT
  ) : UInt16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetClassWordNative = Uint16 Function(Pointer<Void>, Int32);
typedef GetClassWordDart = int Function(Pointer<Void>, int);
final GetClassWord = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetClassWordNative, GetClassWordDart>('GetClassWord');
// hWnd : HWND -> Pointer<Void>
// nIndex : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetClassWord(
  hWnd: THandle;   // HWND
  nIndex: Integer   // INT
): Word; stdcall;
  external 'USER32.dll' name 'GetClassWord';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetClassWord"
  c_GetClassWord :: Ptr () -> Int32 -> IO Word16
-- hWnd : HWND -> Ptr ()
-- nIndex : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getclassword =
  foreign "GetClassWord"
    ((ptr void) @-> int32_t @-> returning uint16_t)
(* hWnd : HWND -> (ptr void) *)
(* nIndex : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetClassWord" get-class-word :convention :stdcall) :uint16
  (h-wnd :pointer)   ; HWND
  (n-index :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClassWord = Win32::API::More->new('USER32',
    'WORD GetClassWord(HANDLE hWnd, int nIndex)');
# my $ret = $GetClassWord->Call($hWnd, $nIndex);
# hWnd : HWND -> HANDLE
# nIndex : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目