SetFileCompletionNotificationModes
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL SetFileCompletionNotificationModes(
HANDLE FileHandle,
BYTE Flags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| FileHandle | HANDLE | in | ファイルへのハンドル。 | ||||||
| Flags | BYTE | in | 設定するモード。複数のモードを同時に設定できますが、いったんファイルハンドルにモードを設定すると、それを解除することはできません。
|
戻り値の型: BOOL
公式ドキュメント
ファイルハンドルの通知モードを設定し、指定したファイルに対する完了通知の動作方法を指定できるようにします。
戻り値
成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。
拡張エラー情報を取得するには、 GetLastError を呼び出します。
解説(Remarks)
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT マクロを 0x0600 以降として定義します。詳細については、 Using the Windows Headers を参照してください。
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) | はい |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL SetFileCompletionNotificationModes(
HANDLE FileHandle,
BYTE Flags
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetFileCompletionNotificationModes(
IntPtr FileHandle, // HANDLE
byte Flags // BYTE
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFileCompletionNotificationModes(
FileHandle As IntPtr, ' HANDLE
Flags As Byte ' BYTE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' FileHandle : HANDLE
' Flags : BYTE
Declare PtrSafe Function SetFileCompletionNotificationModes Lib "kernel32" ( _
ByVal FileHandle As LongPtr, _
ByVal Flags As Byte) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetFileCompletionNotificationModes = ctypes.windll.kernel32.SetFileCompletionNotificationModes
SetFileCompletionNotificationModes.restype = wintypes.BOOL
SetFileCompletionNotificationModes.argtypes = [
wintypes.HANDLE, # FileHandle : HANDLE
ctypes.c_ubyte, # Flags : BYTE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
SetFileCompletionNotificationModes = Fiddle::Function.new(
lib['SetFileCompletionNotificationModes'],
[
Fiddle::TYPE_VOIDP, # FileHandle : HANDLE
-Fiddle::TYPE_CHAR, # Flags : BYTE
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn SetFileCompletionNotificationModes(
FileHandle: *mut core::ffi::c_void, // HANDLE
Flags: u8 // BYTE
) -> 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 SetFileCompletionNotificationModes(IntPtr FileHandle, byte Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileCompletionNotificationModes' -Namespace Win32 -PassThru
# $api::SetFileCompletionNotificationModes(FileHandle, Flags)#uselib "KERNEL32.dll"
#func global SetFileCompletionNotificationModes "SetFileCompletionNotificationModes" sptr, sptr
; SetFileCompletionNotificationModes FileHandle, Flags ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; Flags : BYTE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global SetFileCompletionNotificationModes "SetFileCompletionNotificationModes" sptr, int
; res = SetFileCompletionNotificationModes(FileHandle, Flags)
; FileHandle : HANDLE -> "sptr"
; Flags : BYTE -> "int"; BOOL SetFileCompletionNotificationModes(HANDLE FileHandle, BYTE Flags)
#uselib "KERNEL32.dll"
#cfunc global SetFileCompletionNotificationModes "SetFileCompletionNotificationModes" intptr, int
; res = SetFileCompletionNotificationModes(FileHandle, Flags)
; FileHandle : HANDLE -> "intptr"
; Flags : BYTE -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procSetFileCompletionNotificationModes = kernel32.NewProc("SetFileCompletionNotificationModes")
)
// FileHandle (HANDLE), Flags (BYTE)
r1, _, err := procSetFileCompletionNotificationModes.Call(
uintptr(FileHandle),
uintptr(Flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetFileCompletionNotificationModes(
FileHandle: THandle; // HANDLE
Flags: Byte // BYTE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFileCompletionNotificationModes';result := DllCall("KERNEL32\SetFileCompletionNotificationModes"
, "Ptr", FileHandle ; HANDLE
, "UChar", Flags ; BYTE
, "Int") ; return: BOOL●SetFileCompletionNotificationModes(FileHandle, Flags) = DLL("KERNEL32.dll", "bool SetFileCompletionNotificationModes(void*, byte)")
# 呼び出し: SetFileCompletionNotificationModes(FileHandle, Flags)
# FileHandle : HANDLE -> "void*"
# Flags : BYTE -> "byte"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn SetFileCompletionNotificationModes(
FileHandle: ?*anyopaque, // HANDLE
Flags: u8 // BYTE
) callconv(std.os.windows.WINAPI) i32;proc SetFileCompletionNotificationModes(
FileHandle: pointer, # HANDLE
Flags: uint8 # BYTE
): int32 {.importc: "SetFileCompletionNotificationModes", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int SetFileCompletionNotificationModes(
void* FileHandle, // HANDLE
ubyte Flags // BYTE
);ccall((:SetFileCompletionNotificationModes, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, UInt8),
FileHandle, Flags)
# FileHandle : HANDLE -> Ptr{Cvoid}
# Flags : BYTE -> UInt8
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetFileCompletionNotificationModes(
void* FileHandle,
uint8_t Flags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetFileCompletionNotificationModes(FileHandle, Flags)
-- FileHandle : HANDLE
-- Flags : BYTE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetFileCompletionNotificationModes = lib.func('__stdcall', 'SetFileCompletionNotificationModes', 'int32_t', ['void *', 'uint8_t']);
// SetFileCompletionNotificationModes(FileHandle, Flags)
// FileHandle : HANDLE -> 'void *'
// Flags : BYTE -> 'uint8_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
SetFileCompletionNotificationModes: { parameters: ["pointer", "u8"], result: "i32" },
});
// lib.symbols.SetFileCompletionNotificationModes(FileHandle, Flags)
// FileHandle : HANDLE -> "pointer"
// Flags : BYTE -> "u8"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetFileCompletionNotificationModes(
void* FileHandle,
uint8_t Flags);
C, "KERNEL32.dll");
// $ffi->SetFileCompletionNotificationModes(FileHandle, Flags);
// FileHandle : HANDLE
// Flags : BYTE
// 構造体/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 SetFileCompletionNotificationModes(
Pointer FileHandle, // HANDLE
byte Flags // BYTE
);
}@[Link("kernel32")]
lib LibKERNEL32
fun SetFileCompletionNotificationModes = SetFileCompletionNotificationModes(
FileHandle : Void*, # HANDLE
Flags : UInt8 # BYTE
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetFileCompletionNotificationModesNative = Int32 Function(Pointer<Void>, Uint8);
typedef SetFileCompletionNotificationModesDart = int Function(Pointer<Void>, int);
final SetFileCompletionNotificationModes = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<SetFileCompletionNotificationModesNative, SetFileCompletionNotificationModesDart>('SetFileCompletionNotificationModes');
// FileHandle : HANDLE -> Pointer<Void>
// Flags : BYTE -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetFileCompletionNotificationModes(
FileHandle: THandle; // HANDLE
Flags: Byte // BYTE
): BOOL; stdcall;
external 'KERNEL32.dll' name 'SetFileCompletionNotificationModes';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetFileCompletionNotificationModes"
c_SetFileCompletionNotificationModes :: Ptr () -> Word8 -> IO CInt
-- FileHandle : HANDLE -> Ptr ()
-- Flags : BYTE -> Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setfilecompletionnotificationmodes =
foreign "SetFileCompletionNotificationModes"
((ptr void) @-> uint8_t @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* Flags : BYTE -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("SetFileCompletionNotificationModes" set-file-completion-notification-modes :convention :stdcall) :int32
(file-handle :pointer) ; HANDLE
(flags :uint8)) ; BYTE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetFileCompletionNotificationModes = Win32::API::More->new('KERNEL32',
'BOOL SetFileCompletionNotificationModes(HANDLE FileHandle, BYTE Flags)');
# my $ret = $SetFileCompletionNotificationModes->Call($FileHandle, $Flags);
# FileHandle : HANDLE -> HANDLE
# Flags : BYTE -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。