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

CfQuerySyncProviderStatus

関数
同期プロバイダーの現在の稼働状態を照会する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfQuerySyncProviderStatus(
    CF_CONNECTION_KEY ConnectionKey,
    CF_SYNC_PROVIDER_STATUS* ProviderStatus
);

パラメーター

名前方向説明
ConnectionKeyCF_CONNECTION_KEYin状態を問い合わせる接続を識別するCF_CONNECTION_KEY。
ProviderStatusCF_SYNC_PROVIDER_STATUS*out現在の同期プロバイダー状態を受け取るCF_SYNC_PROVIDER_STATUSへのポインタ。出力用。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

CfQuerySyncProviderStatus = ctypes.windll.cldapi.CfQuerySyncProviderStatus
CfQuerySyncProviderStatus.restype = ctypes.c_int
CfQuerySyncProviderStatus.argtypes = [
    ctypes.c_longlong,  # ConnectionKey : CF_CONNECTION_KEY
    ctypes.c_void_p,  # ProviderStatus : CF_SYNC_PROVIDER_STATUS* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfQuerySyncProviderStatus = Fiddle::Function.new(
  lib['CfQuerySyncProviderStatus'],
  [
    Fiddle::TYPE_LONG_LONG,  # ConnectionKey : CF_CONNECTION_KEY
    Fiddle::TYPE_VOIDP,  # ProviderStatus : CF_SYNC_PROVIDER_STATUS* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfQuerySyncProviderStatus(
        ConnectionKey: i64,  // CF_CONNECTION_KEY
        ProviderStatus: *mut u32  // CF_SYNC_PROVIDER_STATUS* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("cldapi.dll")]
public static extern int CfQuerySyncProviderStatus(long ConnectionKey, out uint ProviderStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfQuerySyncProviderStatus' -Namespace Win32 -PassThru
# $api::CfQuerySyncProviderStatus(ConnectionKey, ProviderStatus)
#uselib "cldapi.dll"
#func global CfQuerySyncProviderStatus "CfQuerySyncProviderStatus" sptr, sptr
; CfQuerySyncProviderStatus ConnectionKey, varptr(ProviderStatus)   ; 戻り値は stat
; ConnectionKey : CF_CONNECTION_KEY -> "sptr"
; ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "cldapi.dll"
#cfunc global CfQuerySyncProviderStatus "CfQuerySyncProviderStatus" int64, var
; res = CfQuerySyncProviderStatus(ConnectionKey, ProviderStatus)
; ConnectionKey : CF_CONNECTION_KEY -> "int64"
; ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; HRESULT CfQuerySyncProviderStatus(CF_CONNECTION_KEY ConnectionKey, CF_SYNC_PROVIDER_STATUS* ProviderStatus)
#uselib "cldapi.dll"
#cfunc global CfQuerySyncProviderStatus "CfQuerySyncProviderStatus" int64, var
; res = CfQuerySyncProviderStatus(ConnectionKey, ProviderStatus)
; ConnectionKey : CF_CONNECTION_KEY -> "int64"
; ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfQuerySyncProviderStatus = cldapi.NewProc("CfQuerySyncProviderStatus")
)

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

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

typedef CfQuerySyncProviderStatusNative = Int32 Function(Int64, Pointer<Uint32>);
typedef CfQuerySyncProviderStatusDart = int Function(int, Pointer<Uint32>);
final CfQuerySyncProviderStatus = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfQuerySyncProviderStatusNative, CfQuerySyncProviderStatusDart>('CfQuerySyncProviderStatus');
// ConnectionKey : CF_CONNECTION_KEY -> Int64
// ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfQuerySyncProviderStatus(
  ConnectionKey: Int64;   // CF_CONNECTION_KEY
  ProviderStatus: Pointer   // CF_SYNC_PROVIDER_STATUS* out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfQuerySyncProviderStatus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfQuerySyncProviderStatus"
  c_CfQuerySyncProviderStatus :: Int64 -> Ptr Word32 -> IO Int32
-- ConnectionKey : CF_CONNECTION_KEY -> Int64
-- ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfquerysyncproviderstatus =
  foreign "CfQuerySyncProviderStatus"
    (int64_t @-> (ptr uint32_t) @-> returning int32_t)
(* ConnectionKey : CF_CONNECTION_KEY -> int64_t *)
(* ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfQuerySyncProviderStatus" cf-query-sync-provider-status :convention :stdcall) :int32
  (connection-key :int64)   ; CF_CONNECTION_KEY
  (provider-status :pointer))   ; CF_SYNC_PROVIDER_STATUS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfQuerySyncProviderStatus = Win32::API::More->new('cldapi',
    'int CfQuerySyncProviderStatus(INT64 ConnectionKey, LPVOID ProviderStatus)');
# my $ret = $CfQuerySyncProviderStatus->Call($ConnectionKey, $ProviderStatus);
# ConnectionKey : CF_CONNECTION_KEY -> INT64
# ProviderStatus : CF_SYNC_PROVIDER_STATUS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型