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

CfConvertToPlaceholder

関数
既存ファイルをクラウドのプレースホルダーへ変換する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfConvertToPlaceholder(
    HANDLE FileHandle,
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    CF_CONVERT_FLAGS ConvertFlags,
    LONGLONG* ConvertUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向
FileHandleHANDLEin
FileIdentityvoid*inoptional
FileIdentityLengthDWORDin
ConvertFlagsCF_CONVERT_FLAGSin
ConvertUsnLONGLONG*outoptional
OverlappedOVERLAPPED*inoutoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfConvertToPlaceholder(
    HANDLE FileHandle,
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    CF_CONVERT_FLAGS ConvertFlags,
    LONGLONG* ConvertUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfConvertToPlaceholder(
    IntPtr FileHandle,   // HANDLE
    IntPtr FileIdentity,   // void* optional
    uint FileIdentityLength,   // DWORD
    int ConvertFlags,   // CF_CONVERT_FLAGS
    IntPtr ConvertUsn,   // LONGLONG* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfConvertToPlaceholder(
    FileHandle As IntPtr,   ' HANDLE
    FileIdentity As IntPtr,   ' void* optional
    FileIdentityLength As UInteger,   ' DWORD
    ConvertFlags As Integer,   ' CF_CONVERT_FLAGS
    ConvertUsn As IntPtr,   ' LONGLONG* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As Integer
End Function
' FileHandle : HANDLE
' FileIdentity : void* optional
' FileIdentityLength : DWORD
' ConvertFlags : CF_CONVERT_FLAGS
' ConvertUsn : LONGLONG* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function CfConvertToPlaceholder Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByVal FileIdentity As LongPtr, _
    ByVal FileIdentityLength As Long, _
    ByVal ConvertFlags As Long, _
    ByVal ConvertUsn 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

CfConvertToPlaceholder = ctypes.windll.cldapi.CfConvertToPlaceholder
CfConvertToPlaceholder.restype = ctypes.c_int
CfConvertToPlaceholder.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.POINTER(None),  # FileIdentity : void* optional
    wintypes.DWORD,  # FileIdentityLength : DWORD
    ctypes.c_int,  # ConvertFlags : CF_CONVERT_FLAGS
    ctypes.POINTER(ctypes.c_longlong),  # ConvertUsn : LONGLONG* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfConvertToPlaceholder = Fiddle::Function.new(
  lib['CfConvertToPlaceholder'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FileIdentity : void* optional
    -Fiddle::TYPE_INT,  # FileIdentityLength : DWORD
    Fiddle::TYPE_INT,  # ConvertFlags : CF_CONVERT_FLAGS
    Fiddle::TYPE_VOIDP,  # ConvertUsn : LONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfConvertToPlaceholder(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        FileIdentity: *const (),  // void* optional
        FileIdentityLength: u32,  // DWORD
        ConvertFlags: i32,  // CF_CONVERT_FLAGS
        ConvertUsn: *mut i64,  // LONGLONG* optional, 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 CfConvertToPlaceholder(IntPtr FileHandle, IntPtr FileIdentity, uint FileIdentityLength, int ConvertFlags, IntPtr ConvertUsn, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfConvertToPlaceholder' -Namespace Win32 -PassThru
# $api::CfConvertToPlaceholder(FileHandle, FileIdentity, FileIdentityLength, ConvertFlags, ConvertUsn, Overlapped)
#uselib "cldapi.dll"
#func global CfConvertToPlaceholder "CfConvertToPlaceholder" sptr, sptr, sptr, sptr, sptr, sptr
; CfConvertToPlaceholder FileHandle, FileIdentity, FileIdentityLength, ConvertFlags, varptr(ConvertUsn), varptr(Overlapped)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; FileIdentity : void* optional -> "sptr"
; FileIdentityLength : DWORD -> "sptr"
; ConvertFlags : CF_CONVERT_FLAGS -> "sptr"
; ConvertUsn : LONGLONG* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "cldapi.dll"
#cfunc global CfConvertToPlaceholder "CfConvertToPlaceholder" sptr, sptr, int, int, var, var
; res = CfConvertToPlaceholder(FileHandle, FileIdentity, FileIdentityLength, ConvertFlags, ConvertUsn, Overlapped)
; FileHandle : HANDLE -> "sptr"
; FileIdentity : void* optional -> "sptr"
; FileIdentityLength : DWORD -> "int"
; ConvertFlags : CF_CONVERT_FLAGS -> "int"
; ConvertUsn : LONGLONG* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CfConvertToPlaceholder(HANDLE FileHandle, void* FileIdentity, DWORD FileIdentityLength, CF_CONVERT_FLAGS ConvertFlags, LONGLONG* ConvertUsn, OVERLAPPED* Overlapped)
#uselib "cldapi.dll"
#cfunc global CfConvertToPlaceholder "CfConvertToPlaceholder" intptr, intptr, int, int, var, var
; res = CfConvertToPlaceholder(FileHandle, FileIdentity, FileIdentityLength, ConvertFlags, ConvertUsn, Overlapped)
; FileHandle : HANDLE -> "intptr"
; FileIdentity : void* optional -> "intptr"
; FileIdentityLength : DWORD -> "int"
; ConvertFlags : CF_CONVERT_FLAGS -> "int"
; ConvertUsn : LONGLONG* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfConvertToPlaceholder = cldapi.NewProc("CfConvertToPlaceholder")
)

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