WinHelpW
関数シグネチャ
// USER32.dll (Unicode / -W)
#include <windows.h>
BOOL WinHelpW(
HWND hWndMain, // optional
LPCWSTR lpszHelp, // optional
DWORD uCommand,
UINT_PTR dwData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWndMain | HWND | inoptional | ヘルプを要求するウィンドウへのハンドルです。WinHelp 関数はこのハンドルを使用して、どのアプリケーションがヘルプを要求したかを追跡します。uCommand パラメーターに HELP_CONTEXTMENU または HELP_WM_HELP を指定した場合、hWndMain はヘルプを要求するコントロールを識別します。 |
| lpszHelp | LPCWSTR | inoptional | WinHelp が表示するヘルプ ファイルの名前(必要に応じてパスを含む)を格納した、null 終端文字列のアドレスです。 トピックをプライマリ ウィンドウではなくセカンダリ ウィンドウに表示する場合は、ファイル名の後に山かっこ (>) とセカンダリ ウィンドウの名前を続けることができます。セカンダリ ウィンドウの名前は、ヘルプ プロジェクト (.hpj) ファイルの [WINDOWS] セクションで定義する必要があります。 |
| uCommand | DWORD | in | 要求するヘルプの種類です。指定可能な値と、それが dwData パラメーターに設定する値にどのように影響するかについては、「解説」セクションを参照してください。 |
| dwData | UINT_PTR | in | 追加データです。使用する値は uCommand パラメーターの値によって異なります。指定可能な dwData の値の一覧については、「解説」セクションを参照してください。 |
戻り値の型: BOOL
公式ドキュメント
Windows ヘルプ (Winhelp.exe) を起動し、アプリケーションが要求するヘルプの種類を示す追加データを渡します。(Unicode)
戻り値
型: BOOL
成功した場合は 0 以外、それ以外の場合は 0 を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
ヘルプを要求したウィンドウを閉じる前に、アプリケーションは uCommand パラメーターに HELP_QUIT を設定して WinHelp を呼び出す必要があります。すべてのアプリケーションがこれを実行するまで、Windows ヘルプは終了しません。ただし、Windows ヘルプを起動するために HELP_CONTEXTPOPUP コマンドを使用した場合は、HELP_QUIT コマンドで Windows ヘルプを呼び出す必要はありません。
この関数は、現在のユーザー以外のコンテキストから呼び出された場合は失敗します。
次の表は、uCommand パラメーターに指定可能な値と、それに対応する dwData パラメーターの形式を示しています。
| uCommand | 動作 | dwData |
|---|---|---|
| HELP_COMMAND | ヘルプ マクロまたはマクロ文字列を実行します。 | 実行するヘルプ マクロの名前を指定する文字列のアドレスです。文字列に複数のマクロ名を指定する場合は、名前をセミコロンで区切る必要があります。一部のマクロでは、Windows ヘルプが長い名前をサポートしていないため、マクロ名の短い形式を使用する必要があります。 |
| HELP_CONTENTS | .hpj ファイルの [OPTIONS] セクションにある Contents オプションで指定されたトピックを表示します。このコマンドは下位互換性のためのものです。新しいアプリケーションでは、.cnt ファイルを提供し、HELP_FINDER コマンドを使用してください。 | 無視されます。0 に設定します。 |
| HELP_CONTEXT | .hpj ファイルの [MAP] セクションで定義された、指定したコンテキスト識別子で識別されるトピックを表示します。 | トピックのコンテキスト識別子を格納します。 |
| HELP_CONTEXTMENU | 選択したウィンドウの ヘルプ メニューを表示し、選択したコントロールのトピックをポップアップ ウィンドウに表示します。 | DWORD ペアの配列のアドレスです。各ペアの最初の DWORD はコントロール識別子、2 番目はトピックのコンテキスト識別子です。配列は 0 のペア {0,0} で終端する必要があります。特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。 |
| HELP_CONTEXTPOPUP | .hpj ファイルの [MAP] セクションで定義された、指定したコンテキスト識別子で識別されるトピックをポップアップ ウィンドウに表示します。 | トピックのコンテキスト識別子を格納します。 |
| HELP_FINDER | [ヘルプ トピック] ダイアログ ボックスを表示します。 | 無視されます。0 に設定します。 |
| HELP_FORCEFILE | Windows ヘルプが正しいヘルプ ファイルを表示していることを確認します。正しくないヘルプ ファイルが表示されている場合、Windows ヘルプは正しいファイルを開きます。そうでない場合は何も行いません。 | 無視されます。0 に設定します。 |
| HELP_HELPONHELP | Winhlp32.hlp ファイルが利用可能な場合、Windows ヘルプの使用方法に関するヘルプを表示します。 | 無視されます。0 に設定します。 |
| HELP_INDEX | .hpj ファイルの [OPTIONS] セクションにある Contents オプションで指定されたトピックを表示します。このコマンドは下位互換性のためのものです。新しいアプリケーションでは HELP_FINDER コマンドを使用してください。 | 無視されます。0 に設定します。 |
| HELP_KEY | 完全一致がある場合、指定したキーワードに一致するキーワード テーブル内のトピックを表示します。一致が複数ある場合は、[見つかったトピック] リスト ボックスにトピックが一覧表示されたインデックスを表示します。 | キーワード文字列のアドレスです。複数のキーワードはセミコロンで区切る必要があります。 |
| HELP_MULTIKEY | 代替キーワード テーブル内のキーワードで指定されたトピックを表示します。 | テーブルの脚注文字とキーワードを指定する MULTIKEYHELP 構造体のアドレスです。 |
| HELP_PARTIALKEY | 完全一致がある場合、指定したキーワードに一致するキーワード テーブル内のトピックを表示します。一致が複数ある場合は、[見つかったトピック] ダイアログ ボックスを表示します。キーワードを渡さずにインデックスを表示するには、空の文字列へのポインターを使用します。 | キーワード文字列のアドレスです。複数のキーワードはセミコロンで区切る必要があります。 |
| HELP_QUIT | Windows ヘルプが不要になったことを通知します。他にヘルプを要求しているアプリケーションがない場合、Windows は Windows ヘルプを閉じます。 | 無視されます。0 に設定します。 |
| HELP_SETCONTENTS | Contents トピックを指定します。ヘルプ ファイルに関連付けられた .cnt ファイルがない場合、ユーザーが [目次] ボタンをクリックすると、Windows ヘルプはこのトピックを表示します。 | Contents トピックのコンテキスト識別子を格納します。 |
| HELP_SETPOPUP_POS | 後続のポップアップ ウィンドウの位置を設定します。 | 位置データを格納します。MAKELONG を使用して、水平座標と垂直座標を 1 つの値に連結します。ポップアップ ウィンドウは、呼び出されたときにマウス カーソルが指定した位置にあったかのように配置されます。 |
| HELP_SETWINPOS | Windows ヘルプ ウィンドウが最小化されているかメモリ内にある場合に表示し、指定したサイズと位置に設定します。 | プライマリまたはセカンダリのヘルプ ウィンドウのサイズと位置を指定する HELPWININFO 構造体のアドレスです。 |
| HELP_TCARD | コマンドが Windows ヘルプのトレーニング カード インスタンス向けであることを示します。このコマンドはビットごとの OR 演算子を使用して他のコマンドと組み合わせます。 | 組み合わせるコマンドによって異なります。 |
| HELP_WM_HELP | hWndMain パラメーターで識別されるコントロールのトピックをポップアップ ウィンドウに表示します。 | DWORD ペアの配列のアドレスです。各ペアの最初の DWORD はコントロール識別子、2 番目はトピックのコンテキスト識別子です。配列は 0 のペア {0,0} で終端する必要があります。特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。 |
winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WinHelp を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、不一致が生じてコンパイル エラーまたは実行時エラーが発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (Unicode / -W)
#include <windows.h>
BOOL WinHelpW(
HWND hWndMain, // optional
LPCWSTR lpszHelp, // optional
DWORD uCommand,
UINT_PTR dwData
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WinHelpW(
IntPtr hWndMain, // HWND optional
[MarshalAs(UnmanagedType.LPWStr)] string lpszHelp, // LPCWSTR optional
uint uCommand, // DWORD
UIntPtr dwData // UINT_PTR
);<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHelpW(
hWndMain As IntPtr, ' HWND optional
<MarshalAs(UnmanagedType.LPWStr)> lpszHelp As String, ' LPCWSTR optional
uCommand As UInteger, ' DWORD
dwData As UIntPtr ' UINT_PTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hWndMain : HWND optional
' lpszHelp : LPCWSTR optional
' uCommand : DWORD
' dwData : UINT_PTR
Declare PtrSafe Function WinHelpW Lib "user32" ( _
ByVal hWndMain As LongPtr, _
ByVal lpszHelp As LongPtr, _
ByVal uCommand As Long, _
ByVal dwData As LongPtr) As Long
' 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
WinHelpW = ctypes.windll.user32.WinHelpW
WinHelpW.restype = wintypes.BOOL
WinHelpW.argtypes = [
wintypes.HANDLE, # hWndMain : HWND optional
wintypes.LPCWSTR, # lpszHelp : LPCWSTR optional
wintypes.DWORD, # uCommand : DWORD
ctypes.c_size_t, # dwData : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
WinHelpW = Fiddle::Function.new(
lib['WinHelpW'],
[
Fiddle::TYPE_VOIDP, # hWndMain : HWND optional
Fiddle::TYPE_VOIDP, # lpszHelp : LPCWSTR optional
-Fiddle::TYPE_INT, # uCommand : DWORD
Fiddle::TYPE_UINTPTR_T, # dwData : UINT_PTR
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "user32")]
extern "system" {
fn WinHelpW(
hWndMain: *mut core::ffi::c_void, // HWND optional
lpszHelp: *const u16, // LPCWSTR optional
uCommand: u32, // DWORD
dwData: usize // UINT_PTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool WinHelpW(IntPtr hWndMain, [MarshalAs(UnmanagedType.LPWStr)] string lpszHelp, uint uCommand, UIntPtr dwData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_WinHelpW' -Namespace Win32 -PassThru
# $api::WinHelpW(hWndMain, lpszHelp, uCommand, dwData)#uselib "USER32.dll"
#func global WinHelpW "WinHelpW" wptr, wptr, wptr, wptr
; WinHelpW hWndMain, lpszHelp, uCommand, dwData ; 戻り値は stat
; hWndMain : HWND optional -> "wptr"
; lpszHelp : LPCWSTR optional -> "wptr"
; uCommand : DWORD -> "wptr"
; dwData : UINT_PTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global WinHelpW "WinHelpW" sptr, wstr, int, sptr
; res = WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
; hWndMain : HWND optional -> "sptr"
; lpszHelp : LPCWSTR optional -> "wstr"
; uCommand : DWORD -> "int"
; dwData : UINT_PTR -> "sptr"; BOOL WinHelpW(HWND hWndMain, LPCWSTR lpszHelp, DWORD uCommand, UINT_PTR dwData)
#uselib "USER32.dll"
#cfunc global WinHelpW "WinHelpW" intptr, wstr, int, intptr
; res = WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
; hWndMain : HWND optional -> "intptr"
; lpszHelp : LPCWSTR optional -> "wstr"
; uCommand : DWORD -> "int"
; dwData : UINT_PTR -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procWinHelpW = user32.NewProc("WinHelpW")
)
// hWndMain (HWND optional), lpszHelp (LPCWSTR optional), uCommand (DWORD), dwData (UINT_PTR)
r1, _, err := procWinHelpW.Call(
uintptr(hWndMain),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszHelp))),
uintptr(uCommand),
uintptr(dwData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WinHelpW(
hWndMain: THandle; // HWND optional
lpszHelp: PWideChar; // LPCWSTR optional
uCommand: DWORD; // DWORD
dwData: NativeUInt // UINT_PTR
): BOOL; stdcall;
external 'USER32.dll' name 'WinHelpW';result := DllCall("USER32\WinHelpW"
, "Ptr", hWndMain ; HWND optional
, "WStr", lpszHelp ; LPCWSTR optional
, "UInt", uCommand ; DWORD
, "UPtr", dwData ; UINT_PTR
, "Int") ; return: BOOL●WinHelpW(hWndMain, lpszHelp, uCommand, dwData) = DLL("USER32.dll", "bool WinHelpW(void*, char*, dword, int)")
# 呼び出し: WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
# hWndMain : HWND optional -> "void*"
# lpszHelp : LPCWSTR optional -> "char*"
# uCommand : DWORD -> "dword"
# dwData : UINT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "user32" fn WinHelpW(
hWndMain: ?*anyopaque, // HWND optional
lpszHelp: [*c]const u16, // LPCWSTR optional
uCommand: u32, // DWORD
dwData: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc WinHelpW(
hWndMain: pointer, # HWND optional
lpszHelp: WideCString, # LPCWSTR optional
uCommand: uint32, # DWORD
dwData: uint # UINT_PTR
): int32 {.importc: "WinHelpW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "user32");
extern(Windows)
int WinHelpW(
void* hWndMain, // HWND optional
const(wchar)* lpszHelp, // LPCWSTR optional
uint uCommand, // DWORD
size_t dwData // UINT_PTR
);ccall((:WinHelpW, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cwstring, UInt32, Csize_t),
hWndMain, lpszHelp, uCommand, dwData)
# hWndMain : HWND optional -> Ptr{Cvoid}
# lpszHelp : LPCWSTR optional -> Cwstring
# uCommand : DWORD -> UInt32
# dwData : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t WinHelpW(
void* hWndMain,
const uint16_t* lpszHelp,
uint32_t uCommand,
uintptr_t dwData);
]]
local user32 = ffi.load("user32")
-- user32.WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
-- hWndMain : HWND optional
-- lpszHelp : LPCWSTR optional
-- uCommand : DWORD
-- dwData : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const WinHelpW = lib.func('__stdcall', 'WinHelpW', 'int32_t', ['void *', 'str16', 'uint32_t', 'uintptr_t']);
// WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
// hWndMain : HWND optional -> 'void *'
// lpszHelp : LPCWSTR optional -> 'str16'
// uCommand : DWORD -> 'uint32_t'
// dwData : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
WinHelpW: { parameters: ["pointer", "buffer", "u32", "usize"], result: "i32" },
});
// lib.symbols.WinHelpW(hWndMain, lpszHelp, uCommand, dwData)
// hWndMain : HWND optional -> "pointer"
// lpszHelp : LPCWSTR optional -> "buffer"
// uCommand : DWORD -> "u32"
// dwData : UINT_PTR -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WinHelpW(
void* hWndMain,
const uint16_t* lpszHelp,
uint32_t uCommand,
size_t dwData);
C, "USER32.dll");
// $ffi->WinHelpW(hWndMain, lpszHelp, uCommand, dwData);
// hWndMain : HWND optional
// lpszHelp : LPCWSTR optional
// uCommand : DWORD
// dwData : UINT_PTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface User32 extends StdCallLibrary {
User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
boolean WinHelpW(
Pointer hWndMain, // HWND optional
WString lpszHelp, // LPCWSTR optional
int uCommand, // DWORD
long dwData // UINT_PTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("user32")]
lib LibUSER32
fun WinHelpW = WinHelpW(
hWndMain : Void*, # HWND optional
lpszHelp : UInt16*, # LPCWSTR optional
uCommand : UInt32, # DWORD
dwData : LibC::SizeT # UINT_PTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHelpWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, UintPtr);
typedef WinHelpWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int);
final WinHelpW = DynamicLibrary.open('USER32.dll')
.lookupFunction<WinHelpWNative, WinHelpWDart>('WinHelpW');
// hWndMain : HWND optional -> Pointer<Void>
// lpszHelp : LPCWSTR optional -> Pointer<Utf16>
// uCommand : DWORD -> Uint32
// dwData : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHelpW(
hWndMain: THandle; // HWND optional
lpszHelp: PWideChar; // LPCWSTR optional
uCommand: DWORD; // DWORD
dwData: NativeUInt // UINT_PTR
): BOOL; stdcall;
external 'USER32.dll' name 'WinHelpW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHelpW"
c_WinHelpW :: Ptr () -> CWString -> Word32 -> CUIntPtr -> IO CInt
-- hWndMain : HWND optional -> Ptr ()
-- lpszHelp : LPCWSTR optional -> CWString
-- uCommand : DWORD -> Word32
-- dwData : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhelpw =
foreign "WinHelpW"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> size_t @-> returning int32_t)
(* hWndMain : HWND optional -> (ptr void) *)
(* lpszHelp : LPCWSTR optional -> (ptr uint16_t) *)
(* uCommand : DWORD -> uint32_t *)
(* dwData : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("WinHelpW" win-help-w :convention :stdcall) :int32
(h-wnd-main :pointer) ; HWND optional
(lpsz-help (:string :encoding :utf-16le)) ; LPCWSTR optional
(u-command :uint32) ; DWORD
(dw-data :uint64)) ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHelpW = Win32::API::More->new('USER32',
'BOOL WinHelpW(HANDLE hWndMain, LPCWSTR lpszHelp, DWORD uCommand, WPARAM dwData)');
# my $ret = $WinHelpW->Call($hWndMain, $lpszHelp, $uCommand, $dwData);
# hWndMain : HWND optional -> HANDLE
# lpszHelp : LPCWSTR optional -> LPCWSTR
# uCommand : DWORD -> DWORD
# dwData : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f WinHelpA (ANSI版) — WinHelpヘルプシステムを起動する(ANSI版)。