ホーム › Data.HtmlHelp › HH_AKLINK
HH_AKLINK
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| cbStruct | INT | 4 | +0 | +0 | 構造体のサイズを指定します。この値は、構造体を HTML Help API に渡す前に必ず設定しておかなければなりません。 |
| fReserved | BOOL | 4 | +4 | +4 | このパラメーターは FALSE に設定しなければなりません。 |
| pszKeywords | CHAR* | 8/4 | +8 | +8 | 検索する 1 つ以上の ALink 名または KLink キーワードを指定します。複数の項目はセミコロンで区切ります。 |
| pszUrl | CHAR* | 8/4 | +16 | +12 | 検索に失敗した場合に移動するトピック ファイルを指定します。pszURL は、指定されたコンパイル済みヘルプ (.chm) ファイル内の有効なトピックを参照するものであり、HTML ファイルを指すインターネット プロトコルはサポートしません。 |
| pszMsgText | CHAR* | 8/4 | +24 | +16 | 検索に失敗し、かつ fIndexOnFail が FALSE で pszURL が NULL の場合に、メッセージ ボックスに表示するテキストを指定します。 |
| pszMsgTitle | CHAR* | 8/4 | +32 | +20 | pszMsgText パラメーターを表示するメッセージ ボックスのキャプションを指定します。 |
| pszWindow | CHAR* | 8/4 | +40 | +24 | 次のいずれかを表示するウィンドウの種類の名前を指定します。
|
| fIndexOnFail | BOOL | 4 | +48 | +28 | 検索に失敗した場合に、HTML Help Viewer の [インデックス] タブにキーワードを表示するかどうかを指定します。対象となるヘルプ ビューアーは pszWindow の値で指定します。 |
公式ドキュメント
検索対象となる 1 つ以上の ALink 名または KLink キーワードを指定するために、この構造体を使用します。
解説(Remarks)
- ALink 名および KLink キーワードの検索では大文字と小文字が区別され、複数のキーワードはセミコロンで区切ります。
- 検索によって 1 つ以上の一致するトピックが見つかった場合は、それらのトピックのタイトルが [検索されたトピック] ダイアログ ボックスに表示されます。
- fIndexOnFail。fIndexOnFail が TRUE の場合、pszWindow で指定されたヘルプ ウィンドウで [インデックス] タブが選択され、pszKeyword で指定されたキーワードが入力フィールドで選択されます。
- pszURL。fIndexOnFail が FALSE の場合、pszURL で指定されたトピック ファイルが pszWindow で指定されたヘルプ ウィンドウに表示されます。
- pszMsgText および pszMsgTitle。fIndexOnFail が FALSE で pszURL が NULL の場合、pszMsgText と pszMsgTitle で指定されたテキストとキャプションを使用してメッセージ ボックスが表示されます。
使用元
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// HH_AKLINK (x64 56 / x86 32 バイト)
typedef struct HH_AKLINK {
INT cbStruct;
BOOL fReserved;
CHAR* pszKeywords;
CHAR* pszUrl;
CHAR* pszMsgText;
CHAR* pszMsgTitle;
CHAR* pszWindow;
BOOL fIndexOnFail;
} HH_AKLINK;using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct HH_AKLINK
{
public int cbStruct;
[MarshalAs(UnmanagedType.Bool)] public bool fReserved;
public IntPtr pszKeywords;
public IntPtr pszUrl;
public IntPtr pszMsgText;
public IntPtr pszMsgTitle;
public IntPtr pszWindow;
[MarshalAs(UnmanagedType.Bool)] public bool fIndexOnFail;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure HH_AKLINK
Public cbStruct As Integer
<MarshalAs(UnmanagedType.Bool)> Public fReserved As Boolean
Public pszKeywords As IntPtr
Public pszUrl As IntPtr
Public pszMsgText As IntPtr
Public pszMsgTitle As IntPtr
Public pszWindow As IntPtr
<MarshalAs(UnmanagedType.Bool)> Public fIndexOnFail As Boolean
End Structureimport ctypes
from ctypes import wintypes
class HH_AKLINK(ctypes.Structure):
_fields_ = [
("cbStruct", ctypes.c_int),
("fReserved", wintypes.BOOL),
("pszKeywords", ctypes.c_void_p),
("pszUrl", ctypes.c_void_p),
("pszMsgText", ctypes.c_void_p),
("pszMsgTitle", ctypes.c_void_p),
("pszWindow", ctypes.c_void_p),
("fIndexOnFail", wintypes.BOOL),
]#[repr(C)]
pub struct HH_AKLINK {
pub cbStruct: i32,
pub fReserved: i32,
pub pszKeywords: *mut core::ffi::c_void,
pub pszUrl: *mut core::ffi::c_void,
pub pszMsgText: *mut core::ffi::c_void,
pub pszMsgTitle: *mut core::ffi::c_void,
pub pszWindow: *mut core::ffi::c_void,
pub fIndexOnFail: i32,
}import "golang.org/x/sys/windows"
type HH_AKLINK struct {
cbStruct int32
fReserved int32
pszKeywords uintptr
pszUrl uintptr
pszMsgText uintptr
pszMsgTitle uintptr
pszWindow uintptr
fIndexOnFail int32
}type
HH_AKLINK = record
cbStruct: Integer;
fReserved: BOOL;
pszKeywords: Pointer;
pszUrl: Pointer;
pszMsgText: Pointer;
pszMsgTitle: Pointer;
pszWindow: Pointer;
fIndexOnFail: BOOL;
end;const HH_AKLINK = extern struct {
cbStruct: i32,
fReserved: i32,
pszKeywords: ?*anyopaque,
pszUrl: ?*anyopaque,
pszMsgText: ?*anyopaque,
pszMsgTitle: ?*anyopaque,
pszWindow: ?*anyopaque,
fIndexOnFail: i32,
};type
HH_AKLINK {.bycopy.} = object
cbStruct: int32
fReserved: int32
pszKeywords: pointer
pszUrl: pointer
pszMsgText: pointer
pszMsgTitle: pointer
pszWindow: pointer
fIndexOnFail: int32struct HH_AKLINK
{
int cbStruct;
int fReserved;
void* pszKeywords;
void* pszUrl;
void* pszMsgText;
void* pszMsgTitle;
void* pszWindow;
int fIndexOnFail;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; HH_AKLINK サイズ: 32 バイト(x86)
dim st, 8 ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; cbStruct : INT (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; fReserved : BOOL (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; pszKeywords : CHAR* (+8, 4byte) st.2 = 値 / 値 = st.2 (lpoke/lpeek も可)
; pszUrl : CHAR* (+12, 4byte) st.3 = 値 / 値 = st.3 (lpoke/lpeek も可)
; pszMsgText : CHAR* (+16, 4byte) st.4 = 値 / 値 = st.4 (lpoke/lpeek も可)
; pszMsgTitle : CHAR* (+20, 4byte) st.5 = 値 / 値 = st.5 (lpoke/lpeek も可)
; pszWindow : CHAR* (+24, 4byte) st.6 = 値 / 値 = st.6 (lpoke/lpeek も可)
; fIndexOnFail : BOOL (+28, 4byte) st.7 = 値 / 値 = st.7 (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; HH_AKLINK サイズ: 56 バイト(x64)
dim st, 14 ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; cbStruct : INT (+0, 4byte) st.0 = 値 / 値 = st.0 (lpoke/lpeek も可)
; fReserved : BOOL (+4, 4byte) st.1 = 値 / 値 = st.1 (lpoke/lpeek も可)
; pszKeywords : CHAR* (+8, 8byte) qpoke st,8,値 / qpeek(st,8) ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; pszUrl : CHAR* (+16, 8byte) qpoke st,16,値 / qpeek(st,16) ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; pszMsgText : CHAR* (+24, 8byte) qpoke st,24,値 / qpeek(st,24) ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; pszMsgTitle : CHAR* (+32, 8byte) qpoke st,32,値 / qpeek(st,32) ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; pszWindow : CHAR* (+40, 8byte) qpoke st,40,値 / qpeek(st,40) ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; fIndexOnFail : BOOL (+48, 4byte) st.12 = 値 / 値 = st.12 (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global HH_AKLINK
#field int cbStruct
#field bool fReserved
#field intptr pszKeywords
#field intptr pszUrl
#field intptr pszMsgText
#field intptr pszMsgTitle
#field intptr pszWindow
#field bool fIndexOnFail
#endstruct
stdim st, HH_AKLINK ; NSTRUCT 変数を確保
st->cbStruct = 100
mes "cbStruct=" + st->cbStruct