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

CfUpdatePlaceholder

関数
プレースホルダーのメタデータやデータ範囲を更新する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfUpdatePlaceholder(
    HANDLE FileHandle,
    const CF_FS_METADATA* FsMetadata,   // optional
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    const CF_FILE_RANGE* DehydrateRangeArray,   // optional
    DWORD DehydrateRangeCount,
    CF_UPDATE_FLAGS UpdateFlags,
    LONGLONG* UpdateUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向
FileHandleHANDLEin
FsMetadataCF_FS_METADATA*inoptional
FileIdentityvoid*inoptional
FileIdentityLengthDWORDin
DehydrateRangeArrayCF_FILE_RANGE*inoptional
DehydrateRangeCountDWORDin
UpdateFlagsCF_UPDATE_FLAGSin
UpdateUsnLONGLONG*inoutoptional
OverlappedOVERLAPPED*inoutoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfUpdatePlaceholder(
    HANDLE FileHandle,
    const CF_FS_METADATA* FsMetadata,   // optional
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    const CF_FILE_RANGE* DehydrateRangeArray,   // optional
    DWORD DehydrateRangeCount,
    CF_UPDATE_FLAGS UpdateFlags,
    LONGLONG* UpdateUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfUpdatePlaceholder(
    IntPtr FileHandle,   // HANDLE
    IntPtr FsMetadata,   // CF_FS_METADATA* optional
    IntPtr FileIdentity,   // void* optional
    uint FileIdentityLength,   // DWORD
    IntPtr DehydrateRangeArray,   // CF_FILE_RANGE* optional
    uint DehydrateRangeCount,   // DWORD
    int UpdateFlags,   // CF_UPDATE_FLAGS
    IntPtr UpdateUsn,   // LONGLONG* optional, in/out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfUpdatePlaceholder(
    FileHandle As IntPtr,   ' HANDLE
    FsMetadata As IntPtr,   ' CF_FS_METADATA* optional
    FileIdentity As IntPtr,   ' void* optional
    FileIdentityLength As UInteger,   ' DWORD
    DehydrateRangeArray As IntPtr,   ' CF_FILE_RANGE* optional
    DehydrateRangeCount As UInteger,   ' DWORD
    UpdateFlags As Integer,   ' CF_UPDATE_FLAGS
    UpdateUsn As IntPtr,   ' LONGLONG* optional, in/out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As Integer
End Function
' FileHandle : HANDLE
' FsMetadata : CF_FS_METADATA* optional
' FileIdentity : void* optional
' FileIdentityLength : DWORD
' DehydrateRangeArray : CF_FILE_RANGE* optional
' DehydrateRangeCount : DWORD
' UpdateFlags : CF_UPDATE_FLAGS
' UpdateUsn : LONGLONG* optional, in/out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function CfUpdatePlaceholder Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByVal FsMetadata As LongPtr, _
    ByVal FileIdentity As LongPtr, _
    ByVal FileIdentityLength As Long, _
    ByVal DehydrateRangeArray As LongPtr, _
    ByVal DehydrateRangeCount As Long, _
    ByVal UpdateFlags As Long, _
    ByVal UpdateUsn As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfUpdatePlaceholder = ctypes.windll.cldapi.CfUpdatePlaceholder
CfUpdatePlaceholder.restype = ctypes.c_int
CfUpdatePlaceholder.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_void_p,  # FsMetadata : CF_FS_METADATA* optional
    ctypes.POINTER(None),  # FileIdentity : void* optional
    wintypes.DWORD,  # FileIdentityLength : DWORD
    ctypes.c_void_p,  # DehydrateRangeArray : CF_FILE_RANGE* optional
    wintypes.DWORD,  # DehydrateRangeCount : DWORD
    ctypes.c_int,  # UpdateFlags : CF_UPDATE_FLAGS
    ctypes.POINTER(ctypes.c_longlong),  # UpdateUsn : LONGLONG* optional, in/out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfUpdatePlaceholder = Fiddle::Function.new(
  lib['CfUpdatePlaceholder'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FsMetadata : CF_FS_METADATA* optional
    Fiddle::TYPE_VOIDP,  # FileIdentity : void* optional
    -Fiddle::TYPE_INT,  # FileIdentityLength : DWORD
    Fiddle::TYPE_VOIDP,  # DehydrateRangeArray : CF_FILE_RANGE* optional
    -Fiddle::TYPE_INT,  # DehydrateRangeCount : DWORD
    Fiddle::TYPE_INT,  # UpdateFlags : CF_UPDATE_FLAGS
    Fiddle::TYPE_VOIDP,  # UpdateUsn : LONGLONG* optional, in/out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfUpdatePlaceholder(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        FsMetadata: *const CF_FS_METADATA,  // CF_FS_METADATA* optional
        FileIdentity: *const (),  // void* optional
        FileIdentityLength: u32,  // DWORD
        DehydrateRangeArray: *const CF_FILE_RANGE,  // CF_FILE_RANGE* optional
        DehydrateRangeCount: u32,  // DWORD
        UpdateFlags: i32,  // CF_UPDATE_FLAGS
        UpdateUsn: *mut i64,  // LONGLONG* optional, in/out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("cldapi.dll")]
public static extern int CfUpdatePlaceholder(IntPtr FileHandle, IntPtr FsMetadata, IntPtr FileIdentity, uint FileIdentityLength, IntPtr DehydrateRangeArray, uint DehydrateRangeCount, int UpdateFlags, IntPtr UpdateUsn, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfUpdatePlaceholder' -Namespace Win32 -PassThru
# $api::CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped)
#uselib "cldapi.dll"
#func global CfUpdatePlaceholder "CfUpdatePlaceholder" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CfUpdatePlaceholder FileHandle, varptr(FsMetadata), FileIdentity, FileIdentityLength, varptr(DehydrateRangeArray), DehydrateRangeCount, UpdateFlags, varptr(UpdateUsn), varptr(Overlapped)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; FsMetadata : CF_FS_METADATA* optional -> "sptr"
; FileIdentity : void* optional -> "sptr"
; FileIdentityLength : DWORD -> "sptr"
; DehydrateRangeArray : CF_FILE_RANGE* optional -> "sptr"
; DehydrateRangeCount : DWORD -> "sptr"
; UpdateFlags : CF_UPDATE_FLAGS -> "sptr"
; UpdateUsn : LONGLONG* optional, in/out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "cldapi.dll"
#cfunc global CfUpdatePlaceholder "CfUpdatePlaceholder" sptr, var, sptr, int, var, int, int, var, var
; res = CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped)
; FileHandle : HANDLE -> "sptr"
; FsMetadata : CF_FS_METADATA* optional -> "var"
; FileIdentity : void* optional -> "sptr"
; FileIdentityLength : DWORD -> "int"
; DehydrateRangeArray : CF_FILE_RANGE* optional -> "var"
; DehydrateRangeCount : DWORD -> "int"
; UpdateFlags : CF_UPDATE_FLAGS -> "int"
; UpdateUsn : LONGLONG* optional, in/out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CfUpdatePlaceholder(HANDLE FileHandle, CF_FS_METADATA* FsMetadata, void* FileIdentity, DWORD FileIdentityLength, CF_FILE_RANGE* DehydrateRangeArray, DWORD DehydrateRangeCount, CF_UPDATE_FLAGS UpdateFlags, LONGLONG* UpdateUsn, OVERLAPPED* Overlapped)
#uselib "cldapi.dll"
#cfunc global CfUpdatePlaceholder "CfUpdatePlaceholder" intptr, var, intptr, int, var, int, int, var, var
; res = CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped)
; FileHandle : HANDLE -> "intptr"
; FsMetadata : CF_FS_METADATA* optional -> "var"
; FileIdentity : void* optional -> "intptr"
; FileIdentityLength : DWORD -> "int"
; DehydrateRangeArray : CF_FILE_RANGE* optional -> "var"
; DehydrateRangeCount : DWORD -> "int"
; UpdateFlags : CF_UPDATE_FLAGS -> "int"
; UpdateUsn : LONGLONG* optional, in/out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfUpdatePlaceholder = cldapi.NewProc("CfUpdatePlaceholder")
)

// FileHandle (HANDLE), FsMetadata (CF_FS_METADATA* optional), FileIdentity (void* optional), FileIdentityLength (DWORD), DehydrateRangeArray (CF_FILE_RANGE* optional), DehydrateRangeCount (DWORD), UpdateFlags (CF_UPDATE_FLAGS), UpdateUsn (LONGLONG* optional, in/out), Overlapped (OVERLAPPED* optional, in/out)
r1, _, err := procCfUpdatePlaceholder.Call(
	uintptr(FileHandle),
	uintptr(FsMetadata),
	uintptr(FileIdentity),
	uintptr(FileIdentityLength),
	uintptr(DehydrateRangeArray),
	uintptr(DehydrateRangeCount),
	uintptr(UpdateFlags),
	uintptr(UpdateUsn),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CfUpdatePlaceholder(
  FileHandle: THandle;   // HANDLE
  FsMetadata: Pointer;   // CF_FS_METADATA* optional
  FileIdentity: Pointer;   // void* optional
  FileIdentityLength: DWORD;   // DWORD
  DehydrateRangeArray: Pointer;   // CF_FILE_RANGE* optional
  DehydrateRangeCount: DWORD;   // DWORD
  UpdateFlags: Integer;   // CF_UPDATE_FLAGS
  UpdateUsn: Pointer;   // LONGLONG* optional, in/out
  Overlapped: Pointer   // OVERLAPPED* optional, in/out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfUpdatePlaceholder';
result := DllCall("cldapi\CfUpdatePlaceholder"
    , "Ptr", FileHandle   ; HANDLE
    , "Ptr", FsMetadata   ; CF_FS_METADATA* optional
    , "Ptr", FileIdentity   ; void* optional
    , "UInt", FileIdentityLength   ; DWORD
    , "Ptr", DehydrateRangeArray   ; CF_FILE_RANGE* optional
    , "UInt", DehydrateRangeCount   ; DWORD
    , "Int", UpdateFlags   ; CF_UPDATE_FLAGS
    , "Ptr", UpdateUsn   ; LONGLONG* optional, in/out
    , "Ptr", Overlapped   ; OVERLAPPED* optional, in/out
    , "Int")   ; return: HRESULT
●CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped) = DLL("cldapi.dll", "int CfUpdatePlaceholder(void*, void*, void*, dword, void*, dword, int, void*, void*)")
# 呼び出し: CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped)
# FileHandle : HANDLE -> "void*"
# FsMetadata : CF_FS_METADATA* optional -> "void*"
# FileIdentity : void* optional -> "void*"
# FileIdentityLength : DWORD -> "dword"
# DehydrateRangeArray : CF_FILE_RANGE* optional -> "void*"
# DehydrateRangeCount : DWORD -> "dword"
# UpdateFlags : CF_UPDATE_FLAGS -> "int"
# UpdateUsn : LONGLONG* optional, in/out -> "void*"
# Overlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。