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

CfGetTransferKey

関数
ファイルデータ転送用の転送キーを取得する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfGetTransferKey(
    HANDLE FileHandle,
    LONGLONG* TransferKey
);

パラメーター

名前方向
FileHandleHANDLEin
TransferKeyLONGLONG*out

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfGetTransferKey(
    HANDLE FileHandle,
    LONGLONG* TransferKey
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfGetTransferKey(
    IntPtr FileHandle,   // HANDLE
    out long TransferKey   // LONGLONG* out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfGetTransferKey(
    FileHandle As IntPtr,   ' HANDLE
    <Out> ByRef TransferKey As Long   ' LONGLONG* out
) As Integer
End Function
' FileHandle : HANDLE
' TransferKey : LONGLONG* out
Declare PtrSafe Function CfGetTransferKey Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByRef TransferKey As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfGetTransferKey = ctypes.windll.cldapi.CfGetTransferKey
CfGetTransferKey.restype = ctypes.c_int
CfGetTransferKey.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.POINTER(ctypes.c_longlong),  # TransferKey : LONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfGetTransferKey = cldapi.NewProc("CfGetTransferKey")
)

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