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

LBItemFromPt

関数
指定座標にあるリストボックス項目の番号を返す。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT LBItemFromPt(
    HWND hLB,
    POINT pt,
    BOOL bAutoScroll
);

パラメーター

名前方向説明
hLBHWNDin調べる対象のリストボックスへのハンドル。
ptPOINTin調べるスクリーン座標を格納した POINT 構造体。
bAutoScrollBOOLinスクロールフラグ。このパラメーターが TRUE で、かつ座標がリストボックスのすぐ上または下にある場合、この関数はリストボックスを 1 行スクロールし、-1 を返します。それ以外の場合、この関数はリストボックスをスクロールしません。

戻り値の型: INT

公式ドキュメント

リストボックス内の指定した座標にある項目のインデックスを取得します。

戻り値

型: int

座標がリスト項目の上にある場合は項目識別子を返し、それ以外の場合は -1 を返します。

解説(Remarks)

LBItemFromPt 関数は、前回スクロールしてから一定の時間が経過した場合にのみリストボックスをスクロールします。このタイミング制御により、関数が短時間に繰り返し呼び出された場合(たとえば DL_DRAGGING 通知コードや WM_MOUSEMOVE メッセージを処理する場合など)に、リストボックスが速くスクロールしすぎるのを防ぎます。

指定した座標がリストボックスのクライアント領域の外にあり、かつ bAutoScrollTRUE の場合、この関数は項目識別子を返す代わりにリストボックスをスクロールします。

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

各言語での呼び出し定義

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

INT LBItemFromPt(
    HWND hLB,
    POINT pt,
    BOOL bAutoScroll
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int LBItemFromPt(
    IntPtr hLB,   // HWND
    POINT pt,   // POINT
    bool bAutoScroll   // BOOL
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function LBItemFromPt(
    hLB As IntPtr,   ' HWND
    pt As POINT,   ' POINT
    bAutoScroll As Boolean   ' BOOL
) As Integer
End Function
' hLB : HWND
' pt : POINT
' bAutoScroll : BOOL
Declare PtrSafe Function LBItemFromPt Lib "comctl32" ( _
    ByVal hLB As LongPtr, _
    ByVal pt As LongPtr, _
    ByVal bAutoScroll As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LBItemFromPt = ctypes.windll.comctl32.LBItemFromPt
LBItemFromPt.restype = ctypes.c_int
LBItemFromPt.argtypes = [
    wintypes.HANDLE,  # hLB : HWND
    POINT,  # pt : POINT
    wintypes.BOOL,  # bAutoScroll : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
LBItemFromPt = Fiddle::Function.new(
  lib['LBItemFromPt'],
  [
    Fiddle::TYPE_VOIDP,  # hLB : HWND
    Fiddle::TYPE_VOIDP,  # pt : POINT
    Fiddle::TYPE_INT,  # bAutoScroll : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn LBItemFromPt(
        hLB: *mut core::ffi::c_void,  // HWND
        pt: POINT,  // POINT
        bAutoScroll: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int LBItemFromPt(IntPtr hLB, POINT pt, bool bAutoScroll);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_LBItemFromPt' -Namespace Win32 -PassThru
# $api::LBItemFromPt(hLB, pt, bAutoScroll)
#uselib "COMCTL32.dll"
#func global LBItemFromPt "LBItemFromPt" sptr, sptr, sptr
; LBItemFromPt hLB, pt, bAutoScroll   ; 戻り値は stat
; hLB : HWND -> "sptr"
; pt : POINT -> "sptr"
; bAutoScroll : BOOL -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global LBItemFromPt "LBItemFromPt" sptr, int, int
; res = LBItemFromPt(hLB, pt, bAutoScroll)
; hLB : HWND -> "sptr"
; pt : POINT -> "int"
; bAutoScroll : BOOL -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; INT LBItemFromPt(HWND hLB, POINT pt, BOOL bAutoScroll)
#uselib "COMCTL32.dll"
#cfunc global LBItemFromPt "LBItemFromPt" intptr, int, int
; res = LBItemFromPt(hLB, pt, bAutoScroll)
; hLB : HWND -> "intptr"
; pt : POINT -> "int"
; bAutoScroll : BOOL -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procLBItemFromPt = comctl32.NewProc("LBItemFromPt")
)

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

extern "comctl32" fn LBItemFromPt(
    hLB: ?*anyopaque, // HWND
    pt: POINT, // POINT
    bAutoScroll: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc LBItemFromPt(
    hLB: pointer,  # HWND
    pt: POINT,  # POINT
    bAutoScroll: int32  # BOOL
): int32 {.importc: "LBItemFromPt", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int LBItemFromPt(
    void* hLB,   // HWND
    POINT pt,   // POINT
    int bAutoScroll   // BOOL
);
ccall((:LBItemFromPt, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, POINT, Int32),
      hLB, pt, bAutoScroll)
# hLB : HWND -> Ptr{Cvoid}
# pt : POINT -> POINT
# bAutoScroll : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t LBItemFromPt(
    void* hLB,
    POINT pt,
    int32_t bAutoScroll);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.LBItemFromPt(hLB, pt, bAutoScroll)
-- hLB : HWND
-- pt : POINT
-- bAutoScroll : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const LBItemFromPt = lib.func('__stdcall', 'LBItemFromPt', 'int32_t', ['void *', 'POINT', 'int32_t']);
// LBItemFromPt(hLB, pt, bAutoScroll)
// hLB : HWND -> 'void *'
// pt : POINT -> 'POINT'
// bAutoScroll : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  LBItemFromPt: { parameters: ["pointer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.LBItemFromPt(hLB, pt, bAutoScroll)
// hLB : HWND -> "pointer"
// pt : POINT -> "buffer"
// bAutoScroll : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t LBItemFromPt(
    void* hLB,
    POINT pt,
    int32_t bAutoScroll);
C, "COMCTL32.dll");
// $ffi->LBItemFromPt(hLB, pt, bAutoScroll);
// hLB : HWND
// pt : POINT
// bAutoScroll : BOOL
// 構造体/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 Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
    int LBItemFromPt(
        Pointer hLB,   // HWND
        POINT /* extends Structure (by value) */ pt,   // POINT
        boolean bAutoScroll   // BOOL
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun LBItemFromPt = LBItemFromPt(
    hLB : Void*,   # HWND
    pt : POINT,   # POINT
    bAutoScroll : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LBItemFromPtNative = Int32 Function(Pointer<Void>, POINT, Int32);
typedef LBItemFromPtDart = int Function(Pointer<Void>, int, int);
final LBItemFromPt = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<LBItemFromPtNative, LBItemFromPtDart>('LBItemFromPt');
// hLB : HWND -> Pointer<Void>
// pt : POINT -> POINT
// bAutoScroll : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LBItemFromPt(
  hLB: THandle;   // HWND
  pt: POINT;   // POINT
  bAutoScroll: BOOL   // BOOL
): Integer; stdcall;
  external 'COMCTL32.dll' name 'LBItemFromPt';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LBItemFromPt"
  c_LBItemFromPt :: Ptr () -> POINT -> CInt -> IO Int32
-- hLB : HWND -> Ptr ()
-- pt : POINT -> POINT
-- bAutoScroll : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let lbitemfrompt =
  foreign "LBItemFromPt"
    ((ptr void) @-> POINT @-> int32_t @-> returning int32_t)
(* hLB : HWND -> (ptr void) *)
(* pt : POINT -> POINT *)
(* bAutoScroll : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("LBItemFromPt" lbitem-from-pt :convention :stdcall) :int32
  (h-lb :pointer)   ; HWND
  (pt (:struct point))   ; POINT
  (b-auto-scroll :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LBItemFromPt = Win32::API::More->new('COMCTL32',
    'int LBItemFromPt(HANDLE hLB, LPVOID pt, BOOL bAutoScroll)');
# my $ret = $LBItemFromPt->Call($hLB, $pt, $bAutoScroll);
# hLB : HWND -> HANDLE
# pt : POINT -> LPVOID
# bAutoScroll : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型