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

CfSetPinState

関数
プレースホルダーファイルのピン留め状態を設定する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfSetPinState(
    HANDLE FileHandle,
    CF_PIN_STATE PinState,
    CF_SET_PIN_FLAGS PinFlags,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前方向
FileHandleHANDLEin
PinStateCF_PIN_STATEin
PinFlagsCF_SET_PIN_FLAGSin
OverlappedOVERLAPPED*inoutoptional

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfSetPinState(
    HANDLE FileHandle,
    CF_PIN_STATE PinState,
    CF_SET_PIN_FLAGS PinFlags,
    OVERLAPPED* Overlapped   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfSetPinState(
    IntPtr FileHandle,   // HANDLE
    int PinState,   // CF_PIN_STATE
    int PinFlags,   // CF_SET_PIN_FLAGS
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfSetPinState(
    FileHandle As IntPtr,   ' HANDLE
    PinState As Integer,   ' CF_PIN_STATE
    PinFlags As Integer,   ' CF_SET_PIN_FLAGS
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As Integer
End Function
' FileHandle : HANDLE
' PinState : CF_PIN_STATE
' PinFlags : CF_SET_PIN_FLAGS
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function CfSetPinState Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByVal PinState As Long, _
    ByVal PinFlags As Long, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfSetPinState = ctypes.windll.cldapi.CfSetPinState
CfSetPinState.restype = ctypes.c_int
CfSetPinState.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_int,  # PinState : CF_PIN_STATE
    ctypes.c_int,  # PinFlags : CF_SET_PIN_FLAGS
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfSetPinState = cldapi.NewProc("CfSetPinState")
)

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