ホーム › UI.Controls.Dialogs › ReplaceTextW

ReplaceTextW

関数

文字列置換の非モーダルダイアログを表示する(Unicode版)。

DLLCOMDLG32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HWND ReplaceTextW(
    FINDREPLACEW* param0
);

パラメーター

名前	型	方向	説明
param0	FINDREPLACEW*	inout	置換ダイアログの初期化と結果通知に使うFINDREPLACEW構造体へのポインタ。Unicode文字列を扱う。

戻り値の型: HWND

公式ドキュメント

検索する文字列と置換後の文字列、および検索と置換の動作を制御するオプションをユーザーが指定できる、システム定義のモードレスダイアログボックスを作成します。(Unicode)

戻り値

型: HWND

関数が成功した場合、戻り値はダイアログボックスのウィンドウハンドルです。このウィンドウハンドルを使用して、ダイアログボックスと通信したり、ダイアログボックスを閉じたりできます。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、CommDlgExtendedError 関数を呼び出します。この関数は、次のいずれかのエラーコードを返すことがあります。

解説(Remarks)

ReplaceText 関数は、テキストの置換操作そのものは行いません。代わりに、ダイアログボックスが FINDMSGSTRING 登録メッセージを、ダイアログボックスのオーナーウィンドウのウィンドウプロシージャに送信します。ダイアログボックスを作成するとき、FINDREPLACE 構造体の hwndOwner メンバーがオーナーウィンドウのハンドルになります。

ReplaceText を呼び出す前に、RegisterWindowMessage 関数を呼び出して FINDMSGSTRING メッセージの識別子を取得する必要があります。ダイアログボックスプロシージャは、ユーザーが [次を検索]、[置換]、[すべて置換] のいずれかのボタンをクリックしたとき、またはダイアログボックスが閉じられるときに、この識別子を使用してメッセージを送信します。FINDMSGSTRING メッセージの lParam パラメーターには、FINDREPLACE 構造体へのポインターが格納されます。この構造体の Flags メンバーは、メッセージの原因となったイベントを示します。構造体のその他のメンバーは、ユーザーの入力を示します。

[置換] ダイアログボックスを作成する場合は、TAB キーや ESC キーなどのキーボード入力をダイアログボックスが正しく処理できるように、アプリケーションのメインメッセージループで IsDialogMessage 関数も使用する必要があります。IsDialogMessage 関数は、[置換] ダイアログボックスがそのメッセージを処理したかどうかを示す値を返します。

[置換] ダイアログボックスには、FRHookProc フックプロシージャを指定できます。フックプロシージャは、ダイアログボックスに送信されるメッセージを処理できます。フックプロシージャを有効にするには、FINDREPLACE 構造体の Flags メンバーに FR_ENABLEHOOK フラグを設定し、lpfnHook メンバーにフックプロシージャのアドレスを指定します。

メモ

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

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

各言語での呼び出し定義

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

HWND ReplaceTextW(
    FINDREPLACEW* param0
);

[DllImport("COMDLG32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr ReplaceTextW(
    IntPtr param0   // FINDREPLACEW* in/out
);

<DllImport("COMDLG32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ReplaceTextW(
    param0 As IntPtr   ' FINDREPLACEW* in/out
) As IntPtr
End Function

' param0 : FINDREPLACEW* in/out
Declare PtrSafe Function ReplaceTextW Lib "comdlg32" ( _
    ByVal param0 As LongPtr) As LongPtr
' 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

ReplaceTextW = ctypes.windll.comdlg32.ReplaceTextW
ReplaceTextW.restype = ctypes.c_void_p
ReplaceTextW.argtypes = [
    ctypes.c_void_p,  # param0 : FINDREPLACEW* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMDLG32.dll')
ReplaceTextW = Fiddle::Function.new(
  lib['ReplaceTextW'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : FINDREPLACEW* in/out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "comdlg32")]
extern "system" {
    fn ReplaceTextW(
        param0: *mut FINDREPLACEW  // FINDREPLACEW* in/out
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("COMDLG32.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr ReplaceTextW(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMDLG32_ReplaceTextW' -Namespace Win32 -PassThru
# $api::ReplaceTextW(param0)

#uselib "COMDLG32.dll"
#func global ReplaceTextW "ReplaceTextW" wptr
; ReplaceTextW varptr(param0)   ; 戻り値は stat
; param0 : FINDREPLACEW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "COMDLG32.dll"
#cfunc global ReplaceTextW "ReplaceTextW" var
; res = ReplaceTextW(param0)
; param0 : FINDREPLACEW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "COMDLG32.dll"
#cfunc global ReplaceTextW "ReplaceTextW" sptr
; res = ReplaceTextW(varptr(param0))
; param0 : FINDREPLACEW* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。