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

SetWindowContextHelpId

関数
ウィンドウにコンテキストヘルプIDを設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// USER32.dll
#include <windows.h>

BOOL SetWindowContextHelpId(
    HWND param0,
    DWORD param1
);

パラメーター

名前方向説明
param0HWNDinヘルプIDを関連付ける対象ウィンドウのハンドル。
param1DWORDinウィンドウに設定するコンテキストヘルプ識別子。

戻り値の型: BOOL

公式ドキュメント

指定したウィンドウにヘルプコンテキスト識別子を関連付けます。

戻り値

型: BOOL

成功した場合は 0 以外の値を、それ以外の場合は 0 を返します。

拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

子ウィンドウがヘルプコンテキスト識別子を持たない場合、その親ウィンドウの識別子を継承します。同様に、所有されているウィンドウがヘルプコンテキスト識別子を持たない場合、その所有元ウィンドウの識別子を継承します。このヘルプコンテキスト識別子の継承により、アプリケーションはダイアログボックスとそのすべてのコントロールに対して 1 つの識別子を設定するだけで済みます。

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

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL SetWindowContextHelpId(
    HWND param0,
    DWORD param1
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetWindowContextHelpId(
    IntPtr param0,   // HWND
    uint param1   // DWORD
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowContextHelpId(
    param0 As IntPtr,   ' HWND
    param1 As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HWND
' param1 : DWORD
Declare PtrSafe Function SetWindowContextHelpId Lib "user32" ( _
    ByVal param0 As LongPtr, _
    ByVal param1 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetWindowContextHelpId = ctypes.windll.user32.SetWindowContextHelpId
SetWindowContextHelpId.restype = wintypes.BOOL
SetWindowContextHelpId.argtypes = [
    wintypes.HANDLE,  # param0 : HWND
    wintypes.DWORD,  # param1 : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetWindowContextHelpId = Fiddle::Function.new(
  lib['SetWindowContextHelpId'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HWND
    -Fiddle::TYPE_INT,  # param1 : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetWindowContextHelpId(
        param0: *mut core::ffi::c_void,  // HWND
        param1: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetWindowContextHelpId(IntPtr param0, uint param1);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowContextHelpId' -Namespace Win32 -PassThru
# $api::SetWindowContextHelpId(param0, param1)
#uselib "USER32.dll"
#func global SetWindowContextHelpId "SetWindowContextHelpId" sptr, sptr
; SetWindowContextHelpId param0, param1   ; 戻り値は stat
; param0 : HWND -> "sptr"
; param1 : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetWindowContextHelpId "SetWindowContextHelpId" sptr, int
; res = SetWindowContextHelpId(param0, param1)
; param0 : HWND -> "sptr"
; param1 : DWORD -> "int"
; BOOL SetWindowContextHelpId(HWND param0, DWORD param1)
#uselib "USER32.dll"
#cfunc global SetWindowContextHelpId "SetWindowContextHelpId" intptr, int
; res = SetWindowContextHelpId(param0, param1)
; param0 : HWND -> "intptr"
; param1 : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetWindowContextHelpId = user32.NewProc("SetWindowContextHelpId")
)

// param0 (HWND), param1 (DWORD)
r1, _, err := procSetWindowContextHelpId.Call(
	uintptr(param0),
	uintptr(param1),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetWindowContextHelpId(
  param0: THandle;   // HWND
  param1: DWORD   // DWORD
): BOOL; stdcall;
  external 'USER32.dll' name 'SetWindowContextHelpId';
result := DllCall("USER32\SetWindowContextHelpId"
    , "Ptr", param0   ; HWND
    , "UInt", param1   ; DWORD
    , "Int")   ; return: BOOL
●SetWindowContextHelpId(param0, param1) = DLL("USER32.dll", "bool SetWindowContextHelpId(void*, dword)")
# 呼び出し: SetWindowContextHelpId(param0, param1)
# param0 : HWND -> "void*"
# param1 : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn SetWindowContextHelpId(
    param0: ?*anyopaque, // HWND
    param1: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SetWindowContextHelpId(
    param0: pointer,  # HWND
    param1: uint32  # DWORD
): int32 {.importc: "SetWindowContextHelpId", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SetWindowContextHelpId(
    void* param0,   // HWND
    uint param1   // DWORD
);
ccall((:SetWindowContextHelpId, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      param0, param1)
# param0 : HWND -> Ptr{Cvoid}
# param1 : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetWindowContextHelpId(
    void* param0,
    uint32_t param1);
]]
local user32 = ffi.load("user32")
-- user32.SetWindowContextHelpId(param0, param1)
-- param0 : HWND
-- param1 : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetWindowContextHelpId = lib.func('__stdcall', 'SetWindowContextHelpId', 'int32_t', ['void *', 'uint32_t']);
// SetWindowContextHelpId(param0, param1)
// param0 : HWND -> 'void *'
// param1 : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetWindowContextHelpId: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.SetWindowContextHelpId(param0, param1)
// param0 : HWND -> "pointer"
// param1 : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetWindowContextHelpId(
    void* param0,
    uint32_t param1);
C, "USER32.dll");
// $ffi->SetWindowContextHelpId(param0, param1);
// param0 : HWND
// param1 : DWORD
// 構造体/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);
    boolean SetWindowContextHelpId(
        Pointer param0,   // HWND
        int param1   // DWORD
    );
}
@[Link("user32")]
lib LibUSER32
  fun SetWindowContextHelpId = SetWindowContextHelpId(
    param0 : Void*,   # HWND
    param1 : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetWindowContextHelpIdNative = Int32 Function(Pointer<Void>, Uint32);
typedef SetWindowContextHelpIdDart = int Function(Pointer<Void>, int);
final SetWindowContextHelpId = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetWindowContextHelpIdNative, SetWindowContextHelpIdDart>('SetWindowContextHelpId');
// param0 : HWND -> Pointer<Void>
// param1 : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetWindowContextHelpId(
  param0: THandle;   // HWND
  param1: DWORD   // DWORD
): BOOL; stdcall;
  external 'USER32.dll' name 'SetWindowContextHelpId';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetWindowContextHelpId"
  c_SetWindowContextHelpId :: Ptr () -> Word32 -> IO CInt
-- param0 : HWND -> Ptr ()
-- param1 : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setwindowcontexthelpid =
  foreign "SetWindowContextHelpId"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* param0 : HWND -> (ptr void) *)
(* param1 : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetWindowContextHelpId" set-window-context-help-id :convention :stdcall) :int32
  (param0 :pointer)   ; HWND
  (param1 :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetWindowContextHelpId = Win32::API::More->new('USER32',
    'BOOL SetWindowContextHelpId(HANDLE param0, DWORD param1)');
# my $ret = $SetWindowContextHelpId->Call($param0, $param1);
# param0 : HWND -> HANDLE
# param1 : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目