ホーム › UI.WindowsAndMessaging › GetAltTabInfoA

GetAltTabInfoA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

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

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

Type: BOOL

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

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

解説(Remarks)

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

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

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

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

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

' hwnd : HWND optional
' iItem : INT
' pati : ALTTABINFO* in/out
' pszItemText : LPSTR optional, out
' cchItemText : DWORD
Declare PtrSafe Function GetAltTabInfoA Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal iItem As Long, _
    ByVal pati As LongPtr, _
    ByVal pszItemText As String, _
    ByVal cchItemText As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetAltTabInfoA = ctypes.windll.user32.GetAltTabInfoA
GetAltTabInfoA.restype = wintypes.BOOL
GetAltTabInfoA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    ctypes.c_int,  # iItem : INT
    ctypes.c_void_p,  # pati : ALTTABINFO* in/out
    wintypes.LPSTR,  # pszItemText : LPSTR 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')
GetAltTabInfoA = Fiddle::Function.new(
  lib['GetAltTabInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    Fiddle::TYPE_INT,  # iItem : INT
    Fiddle::TYPE_VOIDP,  # pati : ALTTABINFO* in/out
    Fiddle::TYPE_VOIDP,  # pszItemText : LPSTR optional, out
    -Fiddle::TYPE_INT,  # cchItemText : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetAltTabInfoA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        iItem: i32,  // INT
        pati: *mut ALTTABINFO,  // ALTTABINFO* in/out
        pszItemText: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool GetAltTabInfoA(IntPtr hwnd, int iItem, IntPtr pati, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszItemText, uint cchItemText);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetAltTabInfoA' -Namespace Win32 -PassThru
# $api::GetAltTabInfoA(hwnd, iItem, pati, pszItemText, cchItemText)

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

出力引数:

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