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

CfReportSyncStatus

関数
同期ルートの同期状態をシェルへ報告する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfReportSyncStatus(
    LPCWSTR SyncRootPath,
    CF_SYNC_STATUS* SyncStatus   // optional
);

パラメーター

名前方向説明
SyncRootPathLPCWSTRin状態を報告する同期ルートディレクトリのフルパスを示すワイド文字列。
SyncStatusCF_SYNC_STATUS*inoptional報告する同期状態を記述したCF_SYNC_STATUS構造体へのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfReportSyncStatus(
    LPCWSTR SyncRootPath,
    CF_SYNC_STATUS* SyncStatus   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfReportSyncStatus(
    [MarshalAs(UnmanagedType.LPWStr)] string SyncRootPath,   // LPCWSTR
    IntPtr SyncStatus   // CF_SYNC_STATUS* optional
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfReportSyncStatus(
    <MarshalAs(UnmanagedType.LPWStr)> SyncRootPath As String,   ' LPCWSTR
    SyncStatus As IntPtr   ' CF_SYNC_STATUS* optional
) As Integer
End Function
' SyncRootPath : LPCWSTR
' SyncStatus : CF_SYNC_STATUS* optional
Declare PtrSafe Function CfReportSyncStatus Lib "cldapi" ( _
    ByVal SyncRootPath As LongPtr, _
    ByVal SyncStatus As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfReportSyncStatus = ctypes.windll.cldapi.CfReportSyncStatus
CfReportSyncStatus.restype = ctypes.c_int
CfReportSyncStatus.argtypes = [
    wintypes.LPCWSTR,  # SyncRootPath : LPCWSTR
    ctypes.c_void_p,  # SyncStatus : CF_SYNC_STATUS* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfReportSyncStatus = cldapi.NewProc("CfReportSyncStatus")
)

// SyncRootPath (LPCWSTR), SyncStatus (CF_SYNC_STATUS* optional)
r1, _, err := procCfReportSyncStatus.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(SyncRootPath))),
	uintptr(SyncStatus),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CfReportSyncStatus(
  SyncRootPath: PWideChar;   // LPCWSTR
  SyncStatus: Pointer   // CF_SYNC_STATUS* optional
): Integer; stdcall;
  external 'cldapi.dll' name 'CfReportSyncStatus';
result := DllCall("cldapi\CfReportSyncStatus"
    , "WStr", SyncRootPath   ; LPCWSTR
    , "Ptr", SyncStatus   ; CF_SYNC_STATUS* optional
    , "Int")   ; return: HRESULT
●CfReportSyncStatus(SyncRootPath, SyncStatus) = DLL("cldapi.dll", "int CfReportSyncStatus(char*, void*)")
# 呼び出し: CfReportSyncStatus(SyncRootPath, SyncStatus)
# SyncRootPath : LPCWSTR -> "char*"
# SyncStatus : CF_SYNC_STATUS* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CfReportSyncStatusNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef CfReportSyncStatusDart = int Function(Pointer<Utf16>, Pointer<Void>);
final CfReportSyncStatus = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfReportSyncStatusNative, CfReportSyncStatusDart>('CfReportSyncStatus');
// SyncRootPath : LPCWSTR -> Pointer<Utf16>
// SyncStatus : CF_SYNC_STATUS* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfReportSyncStatus(
  SyncRootPath: PWideChar;   // LPCWSTR
  SyncStatus: Pointer   // CF_SYNC_STATUS* optional
): Integer; stdcall;
  external 'cldapi.dll' name 'CfReportSyncStatus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfReportSyncStatus"
  c_CfReportSyncStatus :: CWString -> Ptr () -> IO Int32
-- SyncRootPath : LPCWSTR -> CWString
-- SyncStatus : CF_SYNC_STATUS* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfreportsyncstatus =
  foreign "CfReportSyncStatus"
    ((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* SyncRootPath : LPCWSTR -> (ptr uint16_t) *)
(* SyncStatus : CF_SYNC_STATUS* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfReportSyncStatus" cf-report-sync-status :convention :stdcall) :int32
  (sync-root-path (:string :encoding :utf-16le))   ; LPCWSTR
  (sync-status :pointer))   ; CF_SYNC_STATUS* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfReportSyncStatus = Win32::API::More->new('cldapi',
    'int CfReportSyncStatus(LPCWSTR SyncRootPath, LPVOID SyncStatus)');
# my $ret = $CfReportSyncStatus->Call($SyncRootPath, $SyncStatus);
# SyncRootPath : LPCWSTR -> LPCWSTR
# SyncStatus : CF_SYNC_STATUS* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型