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

HELPWININFOA

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 28 バイト / x86: 28 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
wStructSizeINT4+0+0この構造体のサイズ (バイト単位)。
xINT4+4+4ウィンドウの左上隅の X 座標 (スクリーン座標)。
yINT4+8+8ウィンドウの左上隅の Y 座標 (スクリーン座標)。
dxINT4+12+12ウィンドウの幅 (ピクセル単位)。
dyINT4+16+16ウィンドウの高さ (ピクセル単位)。
wMaxINT4+20+20ウィンドウの表示オプション。ShowWindow 関数の nCmdShow パラメーターに指定できる値のいずれかを指定できます。
rgchMemberCHAR2+24+24ウィンドウの名前。

公式ドキュメント

プライマリまたはセカンダリのヘルプ ウィンドウのサイズと位置を格納します。アプリケーションは、HELP_SETWINPOS 値を指定して WinHelp 関数を呼び出すことで、この情報を設定できます。

解説(Remarks)

Windows ヘルプは、X 方向と Y 方向の両方でディスプレイを 1024 単位に分割します。たとえば、ディスプレイの左上 4 分の 1 の領域いっぱいにセカンダリ ウィンドウを作成するには、アプリケーションは x メンバーと y メンバーに 0 を、dx メンバーと dy メンバーに 512 を指定します。

wStructSize を正しく計算するには、rgchMember に格納される文字列の実際のサイズが分かっている必要があります。sizeof(HELPWININFO) には定義上 2 つの TCHAR が含まれているため、最終的な合計を求める際にはそれらを考慮する必要があります。次の例は、wStructSize の適切な計算方法を示しています。

WORD wSize;
TCHAR *szWndName = TEXT("wnd_menu"); 
size_t NameLength;  
HRESULT hr;
HELPWININFO hwi;

// StringCbLength は、終端の NULL 文字を含まない
// 文字列の長さを返します。
hr = StringCbLength(szWndName, STRSAFE_MAX_CCH * sizeof(TCHAR), &NameLength);
    
if (SUCCEEDED(hr))
{
    // 名前文字列の終端 NULL 文字の分のバイト数を加算します。
    NameLength + sizeof(TCHAR);
    
    // TCHAR 配列を除いた HELPWININFO のサイズを求めます。
    wSize = sizeof(HELPWININFO) - (2 * sizeof(TCHAR));
    
    // 最終的な HELPWININFO 構造体の全体のサイズを求めます。
    hwi.wStructSize = wSize + NameLength;
}
メモ

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

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

各言語での定義

#include <windows.h>

// HELPWININFOA  (x64 28 / x86 28 バイト)
typedef struct HELPWININFOA {
    INT wStructSize;
    INT x;
    INT y;
    INT dx;
    INT dy;
    INT wMax;
    CHAR rgchMember[2];
} HELPWININFOA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct HELPWININFOA
{
    public int wStructSize;
    public int x;
    public int y;
    public int dx;
    public int dy;
    public int wMax;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 2)] public sbyte[] rgchMember;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure HELPWININFOA
    Public wStructSize As Integer
    Public x As Integer
    Public y As Integer
    Public dx As Integer
    Public dy As Integer
    Public wMax As Integer
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=2)> Public rgchMember() As SByte
End Structure
import ctypes
from ctypes import wintypes

class HELPWININFOA(ctypes.Structure):
    _fields_ = [
        ("wStructSize", ctypes.c_int),
        ("x", ctypes.c_int),
        ("y", ctypes.c_int),
        ("dx", ctypes.c_int),
        ("dy", ctypes.c_int),
        ("wMax", ctypes.c_int),
        ("rgchMember", ctypes.c_byte * 2),
    ]
#[repr(C)]
pub struct HELPWININFOA {
    pub wStructSize: i32,
    pub x: i32,
    pub y: i32,
    pub dx: i32,
    pub dy: i32,
    pub wMax: i32,
    pub rgchMember: [i8; 2],
}
import "golang.org/x/sys/windows"

type HELPWININFOA struct {
	wStructSize int32
	x int32
	y int32
	dx int32
	dy int32
	wMax int32
	rgchMember [2]int8
}
type
  HELPWININFOA = record
    wStructSize: Integer;
    x: Integer;
    y: Integer;
    dx: Integer;
    dy: Integer;
    wMax: Integer;
    rgchMember: array[0..1] of Shortint;
  end;
const HELPWININFOA = extern struct {
    wStructSize: i32,
    x: i32,
    y: i32,
    dx: i32,
    dy: i32,
    wMax: i32,
    rgchMember: [2]i8,
};
type
  HELPWININFOA {.bycopy.} = object
    wStructSize: int32
    x: int32
    y: int32
    dx: int32
    dy: int32
    wMax: int32
    rgchMember: array[2, int8]
struct HELPWININFOA
{
    int wStructSize;
    int x;
    int y;
    int dx;
    int dy;
    int wMax;
    byte[2] rgchMember;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; HELPWININFOA サイズ: 28 バイト(x64)
dim st, 7    ; 4byte整数×7(構造体サイズ 28 / 4 切り上げ)
; wStructSize : INT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; x : INT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; y : INT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dx : INT (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dy : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; wMax : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; rgchMember : CHAR (+24, 2byte)  varptr(st)+24 を基点に操作(2byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global HELPWININFOA
    #field int wStructSize
    #field int x
    #field int y
    #field int dx
    #field int dy
    #field int wMax
    #field byte rgchMember 2
#endstruct

stdim st, HELPWININFOA        ; NSTRUCT 変数を確保
st->wStructSize = 100
mes "wStructSize=" + st->wStructSize