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

SHChangeNotifyDeregister

関数
シェル変更通知の登録を解除する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL SHChangeNotifyDeregister(
    DWORD ulID
);

パラメーター

名前方向説明
ulIDDWORDinSHChangeNotifyRegister が返した登録 ID を指定する ULONG 型の値です。

戻り値の型: BOOL

公式ドキュメント

クライアントのウィンドウプロセスが SHChangeNotify メッセージを受信しないように登録を解除します。

戻り値

型: BOOL

指定したクライアントが見つかって削除された場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

この関数の使用方法を示す完全な例については、Windows ソフトウェア開発キット (SDK) の Change Notify Watcher Sample を参照してください。

Windows Vista 以降では使用できなくなった NTSHChangeNotifyDeregister 関数は、SHChangeNotifyDeregister と同等のものでした。

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

各言語での呼び出し定義

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

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

SHChangeNotifyDeregister = ctypes.windll.shell32.SHChangeNotifyDeregister
SHChangeNotifyDeregister.restype = wintypes.BOOL
SHChangeNotifyDeregister.argtypes = [
    wintypes.DWORD,  # ulID : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHChangeNotifyDeregister = shell32.NewProc("SHChangeNotifyDeregister")
)

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

extern "shell32" fn SHChangeNotifyDeregister(
    ulID: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SHChangeNotifyDeregister(
    ulID: uint32  # DWORD
): int32 {.importc: "SHChangeNotifyDeregister", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHChangeNotifyDeregister(
    uint ulID   // DWORD
);
ccall((:SHChangeNotifyDeregister, "SHELL32.dll"), stdcall, Int32,
      (UInt32,),
      ulID)
# ulID : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHChangeNotifyDeregister(
    uint32_t ulID);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHChangeNotifyDeregister(ulID)
-- ulID : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHChangeNotifyDeregister = lib.func('__stdcall', 'SHChangeNotifyDeregister', 'int32_t', ['uint32_t']);
// SHChangeNotifyDeregister(ulID)
// ulID : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHChangeNotifyDeregister: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.SHChangeNotifyDeregister(ulID)
// ulID : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHChangeNotifyDeregister(
    uint32_t ulID);
C, "SHELL32.dll");
// $ffi->SHChangeNotifyDeregister(ulID);
// ulID : 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    boolean SHChangeNotifyDeregister(
        int ulID   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHChangeNotifyDeregister = SHChangeNotifyDeregister(
    ulID : 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 SHChangeNotifyDeregisterNative = Int32 Function(Uint32);
typedef SHChangeNotifyDeregisterDart = int Function(int);
final SHChangeNotifyDeregister = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHChangeNotifyDeregisterNative, SHChangeNotifyDeregisterDart>('SHChangeNotifyDeregister');
// ulID : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHChangeNotifyDeregister(
  ulID: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHChangeNotifyDeregister';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shchangenotifyderegister =
  foreign "SHChangeNotifyDeregister"
    (uint32_t @-> returning int32_t)
(* ulID : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHChangeNotifyDeregister" shchange-notify-deregister :convention :stdcall) :int32
  (ul-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHChangeNotifyDeregister = Win32::API::More->new('SHELL32',
    'BOOL SHChangeNotifyDeregister(DWORD ulID)');
# my $ret = $SHChangeNotifyDeregister->Call($ulID);
# ulID : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。