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取得した転送キーを受け取るLONGLONGへのポインタ。出力用で転送操作に使う。

戻り値の型: 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)。
const std = @import("std");

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

typedef CfGetTransferKeyNative = Int32 Function(Pointer<Void>, Pointer<Int64>);
typedef CfGetTransferKeyDart = int Function(Pointer<Void>, Pointer<Int64>);
final CfGetTransferKey = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfGetTransferKeyNative, CfGetTransferKeyDart>('CfGetTransferKey');
// FileHandle : HANDLE -> Pointer<Void>
// TransferKey : LONGLONG* out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfGetTransferKey(
  FileHandle: THandle;   // HANDLE
  TransferKey: Pointer   // LONGLONG* out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfGetTransferKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfGetTransferKey"
  c_CfGetTransferKey :: Ptr () -> Ptr Int64 -> IO Int32
-- FileHandle : HANDLE -> Ptr ()
-- TransferKey : LONGLONG* out -> Ptr Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfgettransferkey =
  foreign "CfGetTransferKey"
    ((ptr void) @-> (ptr int64_t) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* TransferKey : LONGLONG* out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfGetTransferKey" cf-get-transfer-key :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (transfer-key :pointer))   ; LONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfGetTransferKey = Win32::API::More->new('cldapi',
    'int CfGetTransferKey(HANDLE FileHandle, LPVOID TransferKey)');
# my $ret = $CfGetTransferKey->Call($FileHandle, $TransferKey);
# FileHandle : HANDLE -> HANDLE
# TransferKey : LONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。