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

FINDREPLACEA

構造体
サイズx64: 68 バイト / x86: 40 バイトパッキング1

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

フィールド

フィールドサイズx64x86説明
lStructSizeDWORD4+0+0構造体の長さ (バイト単位) です。
hwndOwnerHWND8/4+4+4ダイアログ ボックスを所有するウィンドウのハンドルです。指定したウィンドウのウィンドウ プロシージャは、ダイアログ ボックスから FINDMSGSTRING メッセージを受け取ります。このメンバーには任意の有効なウィンドウ ハンドルを指定できますが、NULL であってはなりません。
hInstanceHINSTANCE8/4+12+8FlagsFR_ENABLETEMPLATEHANDLE フラグが設定されている場合、hInstance はダイアログ ボックス テンプレートを格納するメモリ オブジェクトのハンドルです。FR_ENABLETEMPLATE フラグが設定されている場合、hInstancelpTemplateName メンバーで指定された名前のダイアログ ボックス テンプレートを含むモジュールのハンドルです。どちらのフラグも設定されていない場合、このメンバーは無視されます。
FlagsFINDREPLACE_FLAGS4+20+12

ダイアログ ボックスの初期化に使用できるビット フラグのセットです。ダイアログ ボックスは、ユーザーの入力を示すために FINDMSGSTRING 登録メッセージを送信するとき、これらのフラグを設定します。このメンバーには次の値の 1 つ以上を指定できます。

意味
FR_DIALOGTERM
0x00000040
FINDMSGSTRING メッセージで設定されている場合、ダイアログ ボックスが閉じようとしていることを示します。このフラグが設定されたメッセージを受け取った時点で、FindText 関数または ReplaceText 関数が返したダイアログ ボックスのハンドルは無効になります。
FR_DOWN
0x00000001
設定されている場合、Find ダイアログ ボックスの検索方向を示すラジオ ボタンのうち Down ボタンが選択されており、現在の位置からドキュメントの末尾に向かって検索することを示します。設定されていない場合は Up ボタンが選択されているため、ドキュメントの先頭に向かって検索します。このフラグを設定してダイアログ ボックスを初期化できます。FINDMSGSTRING メッセージで設定されている場合は、ユーザーの選択内容を示します。
FR_ENABLEHOOK
0x00000100
lpfnHook メンバーで指定したフック関数を有効にします。このフラグはダイアログ ボックスの初期化にのみ使用されます。
FR_ENABLETEMPLATE
0x00000200
hInstance メンバーと lpTemplateName メンバーが、既定のテンプレートの代わりに使用するダイアログ ボックス テンプレートを指定することを示します。このフラグはダイアログ ボックスの初期化にのみ使用されます。
FR_ENABLETEMPLATEHANDLE
0x00002000
hInstance メンバーが、あらかじめ読み込まれたダイアログ ボックス テンプレートを含むデータ ブロックを識別することを示します。このフラグを指定すると、システムは lpTemplateName メンバーを無視します。
FR_FINDNEXT
0x00000008
FINDMSGSTRING メッセージで設定されている場合、ユーザーが Find または Replace ダイアログ ボックスの Find Next ボタンをクリックしたことを示します。lpstrFindWhat メンバーは検索する文字列を指定します。
FR_HIDEUPDOWN
0x00004000
Find ダイアログ ボックスの初期化時に設定すると、検索方向を示すラジオ ボタンを非表示にします。
FR_HIDEMATCHCASE
0x00008000
Find または Replace ダイアログ ボックスの初期化時に設定すると、Match Case チェック ボックスを非表示にします。
FR_HIDEWHOLEWORD
0x00010000
Find または Replace ダイアログ ボックスの初期化時に設定すると、Match Whole Word Only チェック ボックスを非表示にします。
FR_MATCHCASE
0x00000004
設定されている場合、Match Case チェック ボックスが選択されており、大文字と小文字を区別して検索することを示します。設定されていない場合はチェック ボックスが選択されていないため、大文字と小文字を区別せずに検索します。このフラグを設定してダイアログ ボックスを初期化できます。FINDMSGSTRING メッセージで設定されている場合は、ユーザーの選択内容を示します。
FR_NOMATCHCASE
0x00000800
Find または Replace ダイアログ ボックスの初期化時に設定すると、Match Case チェック ボックスを無効にします。
FR_NOUPDOWN
0x00000400
Find ダイアログ ボックスの初期化時に設定すると、検索方向を示すラジオ ボタンを無効にします。
FR_NOWHOLEWORD
0x00001000
Find または Replace ダイアログ ボックスの初期化時に設定すると、Whole Word チェック ボックスを無効にします。
FR_REPLACE
0x00000010
FINDMSGSTRING メッセージで設定されている場合、ユーザーが Replace ダイアログ ボックスの Replace ボタンをクリックしたことを示します。lpstrFindWhat メンバーは置換対象の文字列を指定し、lpstrReplaceWith メンバーは置換後の文字列を指定します。
FR_REPLACEALL
0x00000020
FINDMSGSTRING メッセージで設定されている場合、ユーザーが Replace ダイアログ ボックスの Replace All ボタンをクリックしたことを示します。lpstrFindWhat メンバーは置換対象の文字列を指定し、lpstrReplaceWith メンバーは置換後の文字列を指定します。
FR_SHOWHELP
0x00000080
ダイアログ ボックスに Help ボタンを表示させます。hwndOwner メンバーには、ユーザーが Help ボタンをクリックしたときにダイアログ ボックスが送信する HELPMSGSTRING 登録メッセージを受け取るウィンドウを指定する必要があります。
FR_WHOLEWORD
0x00000002
設定されている場合、Match Whole Word Only チェック ボックスが選択されており、検索文字列に一致する単語全体のみを検索することを示します。設定されていない場合はチェック ボックスが選択されていないため、検索文字列に一致する単語の一部も検索します。このフラグを設定してダイアログ ボックスを初期化できます。FINDMSGSTRING メッセージで設定されている場合は、ユーザーの選択内容を示します。
lpstrFindWhatLPSTR8/4+24+16ユーザーが Find What エディット コントロールに入力した検索文字列です。ダイアログ ボックスが閉じる前にスコープ外にならないよう、バッファーを動的に割り当てるか、グローバル配列または静的配列を使用する必要があります。バッファーの長さは 80 文字以上にしてください。ダイアログ ボックスの初期化時にバッファーに文字列が格納されている場合、その文字列が Find What エディット コントロールに表示されます。FINDMSGSTRING メッセージで FR_FINDNEXT フラグが指定されている場合、lpstrFindWhat には検索する文字列が格納されます。FR_DOWNFR_WHOLEWORDFR_MATCHCASE の各フラグは、検索の方向と種類を示します。FINDMSGSTRING メッセージで FR_REPLACE または FR_REPLACE フラグが指定されている場合、lpstrFindWhat には置換対象の文字列が格納されます。
lpstrReplaceWithLPSTR8/4+32+20

ユーザーが Replace With エディット コントロールに入力した置換後の文字列です。ダイアログ ボックスが閉じる前にスコープ外にならないよう、バッファーを動的に割り当てるか、グローバル配列または静的配列を使用する必要があります。ダイアログ ボックスの初期化時にバッファーに文字列が格納されている場合、その文字列が Replace With エディット コントロールに表示されます。

FINDMSGSTRING メッセージで FR_REPLACE または FR_REPLACEALL フラグが指定されている場合、lpstrReplaceWith には置換後の文字列が格納されます。

FindText 関数はこのメンバーを無視します。

wFindWhatLenWORD2+40+24lpstrFindWhat メンバーが指すバッファーの長さ (バイト単位) です。
wReplaceWithLenWORD2+42+26lpstrReplaceWith メンバーが指すバッファーの長さ (バイト単位) です。
lCustDataLPARAM8/4+44+28lpfnHook メンバーで指定されたフック プロシージャにシステムが渡す、アプリケーション定義のデータです。システムがフック プロシージャに WM_INITDIALOG メッセージを送信するとき、そのメッセージの lParam パラメーターは、ダイアログ ボックスの作成時に指定された FINDREPLACE 構造体へのポインターになります。フック プロシージャはこのポインターを使用して lCustData の値を取得できます。
lpfnHookLPFRHOOKPROC8/4+52+32ダイアログ ボックス宛てのメッセージを処理できる FRHookProc フック プロシージャへのポインターです。このメンバーは、Flags メンバーに FR_ENABLEHOOK フラグが設定されていない限り無視されます。フック プロシージャが WM_INITDIALOG メッセージに対して FALSE を返す場合は、フック プロシージャがダイアログ ボックスを表示しなければなりません。表示しなければダイアログ ボックスは表示されません。表示するには、まずその他の描画処理を行ってから、ShowWindow 関数と UpdateWindow 関数を呼び出します。
lpTemplateNameLPSTR8/4+60+36hInstance メンバーで識別されるモジュール内のダイアログ ボックス テンプレート リソースの名前です。このテンプレートは標準のダイアログ ボックス テンプレートの代わりに使用されます。番号付きのダイアログ ボックス リソースの場合は、MAKEINTRESOURCE マクロが返す値を指定できます。このメンバーは、Flags メンバーに FR_ENABLETEMPLATE フラグが設定されていない限り無視されます。

公式ドキュメント

FindText 関数および ReplaceText 関数が Find ダイアログ ボックスと Replace ダイアログ ボックスを初期化するために使用する情報を格納します。FINDMSGSTRING 登録メッセージは、この構造体を使用して、ユーザーが入力した検索文字列または置換文字列を Find または Replace ダイアログ ボックスのオーナー ウィンドウに渡します。

解説(Remarks)

メモ

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

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

各言語での定義

#include <windows.h>

// FINDREPLACEA  (x64 68 / x86 40 バイト)
#pragma pack(push, 1)
typedef struct FINDREPLACEA {
    DWORD lStructSize;
    HWND hwndOwner;
    HINSTANCE hInstance;
    FINDREPLACE_FLAGS Flags;
    LPSTR lpstrFindWhat;
    LPSTR lpstrReplaceWith;
    WORD wFindWhatLen;
    WORD wReplaceWithLen;
    LPARAM lCustData;
    LPFRHOOKPROC lpfnHook;
    LPSTR lpTemplateName;
} FINDREPLACEA;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct FINDREPLACEA
{
    public uint lStructSize;
    public IntPtr hwndOwner;
    public IntPtr hInstance;
    public uint Flags;
    public IntPtr lpstrFindWhat;
    public IntPtr lpstrReplaceWith;
    public ushort wFindWhatLen;
    public ushort wReplaceWithLen;
    public IntPtr lCustData;
    public IntPtr lpfnHook;
    public IntPtr lpTemplateName;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure FINDREPLACEA
    Public lStructSize As UInteger
    Public hwndOwner As IntPtr
    Public hInstance As IntPtr
    Public Flags As UInteger
    Public lpstrFindWhat As IntPtr
    Public lpstrReplaceWith As IntPtr
    Public wFindWhatLen As UShort
    Public wReplaceWithLen As UShort
    Public lCustData As IntPtr
    Public lpfnHook As IntPtr
    Public lpTemplateName As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class FINDREPLACEA(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("lStructSize", wintypes.DWORD),
        ("hwndOwner", ctypes.c_void_p),
        ("hInstance", ctypes.c_void_p),
        ("Flags", wintypes.DWORD),
        ("lpstrFindWhat", ctypes.c_void_p),
        ("lpstrReplaceWith", ctypes.c_void_p),
        ("wFindWhatLen", ctypes.c_ushort),
        ("wReplaceWithLen", ctypes.c_ushort),
        ("lCustData", ctypes.c_ssize_t),
        ("lpfnHook", ctypes.c_void_p),
        ("lpTemplateName", ctypes.c_void_p),
    ]
#[repr(C, packed(1))]
pub struct FINDREPLACEA {
    pub lStructSize: u32,
    pub hwndOwner: *mut core::ffi::c_void,
    pub hInstance: *mut core::ffi::c_void,
    pub Flags: u32,
    pub lpstrFindWhat: *mut core::ffi::c_void,
    pub lpstrReplaceWith: *mut core::ffi::c_void,
    pub wFindWhatLen: u16,
    pub wReplaceWithLen: u16,
    pub lCustData: isize,
    pub lpfnHook: *mut core::ffi::c_void,
    pub lpTemplateName: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type FINDREPLACEA struct {
	lStructSize uint32
	hwndOwner uintptr
	hInstance uintptr
	Flags uint32
	lpstrFindWhat uintptr
	lpstrReplaceWith uintptr
	wFindWhatLen uint16
	wReplaceWithLen uint16
	lCustData uintptr
	lpfnHook uintptr
	lpTemplateName uintptr
}
type
  FINDREPLACEA = packed record
    lStructSize: DWORD;
    hwndOwner: Pointer;
    hInstance: Pointer;
    Flags: DWORD;
    lpstrFindWhat: Pointer;
    lpstrReplaceWith: Pointer;
    wFindWhatLen: Word;
    wReplaceWithLen: Word;
    lCustData: NativeInt;
    lpfnHook: Pointer;
    lpTemplateName: Pointer;
  end;
const FINDREPLACEA = extern struct {
    lStructSize: u32,
    hwndOwner: ?*anyopaque,
    hInstance: ?*anyopaque,
    Flags: u32,
    lpstrFindWhat: ?*anyopaque,
    lpstrReplaceWith: ?*anyopaque,
    wFindWhatLen: u16,
    wReplaceWithLen: u16,
    lCustData: isize,
    lpfnHook: ?*anyopaque,
    lpTemplateName: ?*anyopaque,
};
type
  FINDREPLACEA {.packed.} = object
    lStructSize: uint32
    hwndOwner: pointer
    hInstance: pointer
    Flags: uint32
    lpstrFindWhat: pointer
    lpstrReplaceWith: pointer
    wFindWhatLen: uint16
    wReplaceWithLen: uint16
    lCustData: int
    lpfnHook: pointer
    lpTemplateName: pointer
align(1)
struct FINDREPLACEA
{
    uint lStructSize;
    void* hwndOwner;
    void* hInstance;
    uint Flags;
    void* lpstrFindWhat;
    void* lpstrReplaceWith;
    ushort wFindWhatLen;
    ushort wReplaceWithLen;
    ptrdiff_t lCustData;
    void* lpfnHook;
    void* lpTemplateName;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; FINDREPLACEA サイズ: 40 バイト(x86)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; lStructSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hwndOwner : HWND (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; hInstance : HINSTANCE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Flags : FINDREPLACE_FLAGS (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; lpstrFindWhat : LPSTR (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; lpstrReplaceWith : LPSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; wFindWhatLen : WORD (+24, 2byte)  wpoke st,24,値  /  値 = wpeek(st,24)
; wReplaceWithLen : WORD (+26, 2byte)  wpoke st,26,値  /  値 = wpeek(st,26)
; lCustData : LPARAM (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; lpfnHook : LPFRHOOKPROC (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; lpTemplateName : LPSTR (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FINDREPLACEA サイズ: 68 バイト(x64)
dim st, 17    ; 4byte整数×17(構造体サイズ 68 / 4 切り上げ)
; lStructSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hwndOwner : HWND (+4, 8byte)  qpoke st,4,値 / qpeek(st,4)  ※IronHSPのみ。3.7/3.8は lpoke st,4,下位 : lpoke st,8,上位
; hInstance : HINSTANCE (+12, 8byte)  qpoke st,12,値 / qpeek(st,12)  ※IronHSPのみ。3.7/3.8は lpoke st,12,下位 : lpoke st,16,上位
; Flags : FINDREPLACE_FLAGS (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; lpstrFindWhat : LPSTR (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; lpstrReplaceWith : LPSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; wFindWhatLen : WORD (+40, 2byte)  wpoke st,40,値  /  値 = wpeek(st,40)
; wReplaceWithLen : WORD (+42, 2byte)  wpoke st,42,値  /  値 = wpeek(st,42)
; lCustData : LPARAM (+44, 8byte)  qpoke st,44,値 / qpeek(st,44)  ※IronHSPのみ。3.7/3.8は lpoke st,44,下位 : lpoke st,48,上位
; lpfnHook : LPFRHOOKPROC (+52, 8byte)  qpoke st,52,値 / qpeek(st,52)  ※IronHSPのみ。3.7/3.8は lpoke st,52,下位 : lpoke st,56,上位
; lpTemplateName : LPSTR (+60, 8byte)  qpoke st,60,値 / qpeek(st,60)  ※IronHSPのみ。3.7/3.8は lpoke st,60,下位 : lpoke st,64,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FINDREPLACEA, pack=1
    #field int lStructSize
    #field intptr hwndOwner
    #field intptr hInstance
    #field int Flags
    #field intptr lpstrFindWhat
    #field intptr lpstrReplaceWith
    #field short wFindWhatLen
    #field short wReplaceWithLen
    #field intptr lCustData
    #field intptr lpfnHook
    #field intptr lpTemplateName
#endstruct

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