Win32 API 日本語リファレンス
ホームStorage.FileSystem › FindCloseChangeNotification

FindCloseChangeNotification

関数
変更通知ハンドルを閉じて監視を終了する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL FindCloseChangeNotification(
    HANDLE hChangeHandle
);

パラメーター

名前方向説明
hChangeHandleHANDLEinFindFirstChangeNotification 関数によって作成された変更通知ハンドルへのハンドル。

戻り値の型: BOOL

公式ドキュメント

変更通知ハンドルの監視を停止します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

FindCloseChangeNotification 関数が呼び出された後は、hChangeHandle パラメーターで指定されたハンドルを、その後の FindNextChangeNotification または FindCloseChangeNotification 関数の呼び出しで使用することはできません。

変更通知は、 待機関数でも使用できます。

Windows 8 および Windows Server 2012 では、この関数は次の技術によってサポートされます。

技術 サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) 備考を参照
Resilient File System (ReFS) はい

CsvFs の一時停止/再開時に、アプリケーションで誤検出が発生する場合があります。

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

各言語での呼び出し定義

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

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

FindCloseChangeNotification = ctypes.windll.kernel32.FindCloseChangeNotification
FindCloseChangeNotification.restype = wintypes.BOOL
FindCloseChangeNotification.argtypes = [
    wintypes.HANDLE,  # hChangeHandle : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFindCloseChangeNotification = kernel32.NewProc("FindCloseChangeNotification")
)

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

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

typedef FindCloseChangeNotificationNative = Int32 Function(Pointer<Void>);
typedef FindCloseChangeNotificationDart = int Function(Pointer<Void>);
final FindCloseChangeNotification = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindCloseChangeNotificationNative, FindCloseChangeNotificationDart>('FindCloseChangeNotification');
// hChangeHandle : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindCloseChangeNotification(
  hChangeHandle: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FindCloseChangeNotification';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let findclosechangenotification =
  foreign "FindCloseChangeNotification"
    ((ptr void) @-> returning int32_t)
(* hChangeHandle : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("FindCloseChangeNotification" find-close-change-notification :convention :stdcall) :int32
  (h-change-handle :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindCloseChangeNotification = Win32::API::More->new('KERNEL32',
    'BOOL FindCloseChangeNotification(HANDLE hChangeHandle)');
# my $ret = $FindCloseChangeNotification->Call($hChangeHandle);
# hChangeHandle : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目