ホーム › UI.WindowsAndMessaging › GetAltTabInfoW

GetAltTabInfoW

関数

Alt+Tab切替画面の項目情報を取得する(Unicode版)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetAltTabInfoW(
    HWND hwnd,   // optional
    INT iItem,
    ALTTABINFO* pati,
    LPWSTR pszItemText,   // optional
    DWORD cchItemText
);

パラメーター

名前	型	方向	説明
hwnd	HWND	inoptional	ステータス情報を取得する対象のウィンドウへのハンドル。このウィンドウはアプリケーション切り替えウィンドウである必要があります。
iItem	INT	in	アプリケーション切り替えウィンドウ内のアイコンのインデックス。pszItemText パラメーターが NULL でない場合、項目の名前が pszItemText 文字列にコピーされます。このパラメーターが –1 の場合、項目の名前はコピーされません。
pati	ALTTABINFO*	inout	ステータス情報を受け取る ALTTABINFO 構造体へのポインター。この関数を呼び出す前に、csSize メンバーを `sizeof(ALTTABINFO)` に設定する必要があることに注意してください。
pszItemText	LPWSTR	outoptional	項目の名前。このパラメーターが NULL の場合、項目の名前はコピーされません。
cchItemText	DWORD	in	pszItemText バッファーのサイズ (文字数単位)。

戻り値の型: BOOL

公式ドキュメント

指定したウィンドウがアプリケーション切り替え (ALT+TAB) ウィンドウである場合に、そのステータス情報を取得します。(Unicode)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

アプリケーション切り替えウィンドウを使用すると、最近使用したアプリケーションウィンドウに切り替えることができます。アプリケーション切り替えウィンドウを表示するには、ALT+TAB を押します。一覧からアプリケーションを選択するには、ALT を押したまま TAB を押して一覧内を移動します。SHIFT を併用すると、一覧内を逆方向に移動できます。

メモ

winuser.h ヘッダーは GetAltTabInfo をエイリアスとして定義しており、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不一致が発生する可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetAltTabInfoW(
    HWND hwnd,   // optional
    INT iItem,
    ALTTABINFO* pati,
    LPWSTR pszItemText,   // optional
    DWORD cchItemText
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetAltTabInfoW(
    IntPtr hwnd,   // HWND optional
    int iItem,   // INT
    IntPtr pati,   // ALTTABINFO* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszItemText,   // LPWSTR optional, out
    uint cchItemText   // DWORD
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetAltTabInfoW(
    hwnd As IntPtr,   ' HWND optional
    iItem As Integer,   ' INT
    pati As IntPtr,   ' ALTTABINFO* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszItemText As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchItemText As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwnd : HWND optional
' iItem : INT
' pati : ALTTABINFO* in/out
' pszItemText : LPWSTR optional, out
' cchItemText : DWORD
Declare PtrSafe Function GetAltTabInfoW Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal iItem As Long, _
    ByVal pati As LongPtr, _
    ByVal pszItemText As LongPtr, _
    ByVal cchItemText As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAltTabInfoW = ctypes.windll.user32.GetAltTabInfoW
GetAltTabInfoW.restype = wintypes.BOOL
GetAltTabInfoW.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # iItem : INT
    ctypes.c_void_p,  # pati : ALTTABINFO* in/out
    wintypes.LPWSTR,  # pszItemText : LPWSTR optional, out
    wintypes.DWORD,  # cchItemText : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetAltTabInfoW = Fiddle::Function.new(
  lib['GetAltTabInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_INT,  # iItem : INT
    Fiddle::TYPE_VOIDP,  # pati : ALTTABINFO* in/out
    Fiddle::TYPE_VOIDP,  # pszItemText : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchItemText : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetAltTabInfoW(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        iItem: i32,  // INT
        pati: *mut ALTTABINFO,  // ALTTABINFO* in/out
        pszItemText: *mut u16,  // LPWSTR optional, out
        cchItemText: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetAltTabInfoW(IntPtr hwnd, int iItem, IntPtr pati, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszItemText, uint cchItemText);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetAltTabInfoW' -Namespace Win32 -PassThru
# $api::GetAltTabInfoW(hwnd, iItem, pati, pszItemText, cchItemText)

#uselib "USER32.dll"
#func global GetAltTabInfoW "GetAltTabInfoW" wptr, wptr, wptr, wptr, wptr
; GetAltTabInfoW hwnd, iItem, varptr(pati), varptr(pszItemText), cchItemText   ; 戻り値は stat
; hwnd : HWND optional -> "wptr"
; iItem : INT -> "wptr"
; pati : ALTTABINFO* in/out -> "wptr"
; pszItemText : LPWSTR optional, out -> "wptr"
; cchItemText : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetAltTabInfoW "GetAltTabInfoW" sptr, int, var, var, int
; res = GetAltTabInfoW(hwnd, iItem, pati, pszItemText, cchItemText)
; hwnd : HWND optional -> "sptr"
; iItem : INT -> "int"
; pati : ALTTABINFO* in/out -> "var"
; pszItemText : LPWSTR optional, out -> "var"
; cchItemText : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetAltTabInfoW "GetAltTabInfoW" sptr, int, sptr, sptr, int
; res = GetAltTabInfoW(hwnd, iItem, varptr(pati), varptr(pszItemText), cchItemText)
; hwnd : HWND optional -> "sptr"
; iItem : INT -> "int"
; pati : ALTTABINFO* in/out -> "sptr"
; pszItemText : LPWSTR optional, out -> "sptr"
; cchItemText : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。