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

FhServiceStartBackup

関数
ファイル履歴のバックアップ処理を開始する。
DLLfhsvcctl.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT FhServiceStartBackup(
    FH_SERVICE_PIPE_HANDLE Pipe,
    BOOL LowPriorityIo
);

パラメーター

名前方向説明
PipeFH_SERVICE_PIPE_HANDLEin操作対象のファイル履歴サービスパイプハンドル。
LowPriorityIoBOOLinバックアップを低優先度I/Oで実行するかどうかのフラグ。TRUEで低優先度にする。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT FhServiceStartBackup(
    FH_SERVICE_PIPE_HANDLE Pipe,
    BOOL LowPriorityIo
);
[DllImport("fhsvcctl.dll", ExactSpelling = true)]
static extern int FhServiceStartBackup(
    IntPtr Pipe,   // FH_SERVICE_PIPE_HANDLE
    bool LowPriorityIo   // BOOL
);
<DllImport("fhsvcctl.dll", ExactSpelling:=True)>
Public Shared Function FhServiceStartBackup(
    Pipe As IntPtr,   ' FH_SERVICE_PIPE_HANDLE
    LowPriorityIo As Boolean   ' BOOL
) As Integer
End Function
' Pipe : FH_SERVICE_PIPE_HANDLE
' LowPriorityIo : BOOL
Declare PtrSafe Function FhServiceStartBackup Lib "fhsvcctl" ( _
    ByVal Pipe As LongPtr, _
    ByVal LowPriorityIo As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FhServiceStartBackup = ctypes.windll.fhsvcctl.FhServiceStartBackup
FhServiceStartBackup.restype = ctypes.c_int
FhServiceStartBackup.argtypes = [
    wintypes.HANDLE,  # Pipe : FH_SERVICE_PIPE_HANDLE
    wintypes.BOOL,  # LowPriorityIo : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('fhsvcctl.dll')
FhServiceStartBackup = Fiddle::Function.new(
  lib['FhServiceStartBackup'],
  [
    Fiddle::TYPE_VOIDP,  # Pipe : FH_SERVICE_PIPE_HANDLE
    Fiddle::TYPE_INT,  # LowPriorityIo : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "fhsvcctl")]
extern "system" {
    fn FhServiceStartBackup(
        Pipe: *mut core::ffi::c_void,  // FH_SERVICE_PIPE_HANDLE
        LowPriorityIo: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("fhsvcctl.dll")]
public static extern int FhServiceStartBackup(IntPtr Pipe, bool LowPriorityIo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'fhsvcctl_FhServiceStartBackup' -Namespace Win32 -PassThru
# $api::FhServiceStartBackup(Pipe, LowPriorityIo)
#uselib "fhsvcctl.dll"
#func global FhServiceStartBackup "FhServiceStartBackup" sptr, sptr
; FhServiceStartBackup Pipe, LowPriorityIo   ; 戻り値は stat
; Pipe : FH_SERVICE_PIPE_HANDLE -> "sptr"
; LowPriorityIo : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "fhsvcctl.dll"
#cfunc global FhServiceStartBackup "FhServiceStartBackup" sptr, int
; res = FhServiceStartBackup(Pipe, LowPriorityIo)
; Pipe : FH_SERVICE_PIPE_HANDLE -> "sptr"
; LowPriorityIo : BOOL -> "int"
; HRESULT FhServiceStartBackup(FH_SERVICE_PIPE_HANDLE Pipe, BOOL LowPriorityIo)
#uselib "fhsvcctl.dll"
#cfunc global FhServiceStartBackup "FhServiceStartBackup" intptr, int
; res = FhServiceStartBackup(Pipe, LowPriorityIo)
; Pipe : FH_SERVICE_PIPE_HANDLE -> "intptr"
; LowPriorityIo : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	fhsvcctl = windows.NewLazySystemDLL("fhsvcctl.dll")
	procFhServiceStartBackup = fhsvcctl.NewProc("FhServiceStartBackup")
)

// Pipe (FH_SERVICE_PIPE_HANDLE), LowPriorityIo (BOOL)
r1, _, err := procFhServiceStartBackup.Call(
	uintptr(Pipe),
	uintptr(LowPriorityIo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function FhServiceStartBackup(
  Pipe: THandle;   // FH_SERVICE_PIPE_HANDLE
  LowPriorityIo: BOOL   // BOOL
): Integer; stdcall;
  external 'fhsvcctl.dll' name 'FhServiceStartBackup';
result := DllCall("fhsvcctl\FhServiceStartBackup"
    , "Ptr", Pipe   ; FH_SERVICE_PIPE_HANDLE
    , "Int", LowPriorityIo   ; BOOL
    , "Int")   ; return: HRESULT
●FhServiceStartBackup(Pipe, LowPriorityIo) = DLL("fhsvcctl.dll", "int FhServiceStartBackup(void*, bool)")
# 呼び出し: FhServiceStartBackup(Pipe, LowPriorityIo)
# Pipe : FH_SERVICE_PIPE_HANDLE -> "void*"
# LowPriorityIo : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FhServiceStartBackupNative = Int32 Function(Pointer<Void>, Int32);
typedef FhServiceStartBackupDart = int Function(Pointer<Void>, int);
final FhServiceStartBackup = DynamicLibrary.open('fhsvcctl.dll')
    .lookupFunction<FhServiceStartBackupNative, FhServiceStartBackupDart>('FhServiceStartBackup');
// Pipe : FH_SERVICE_PIPE_HANDLE -> Pointer<Void>
// LowPriorityIo : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FhServiceStartBackup(
  Pipe: THandle;   // FH_SERVICE_PIPE_HANDLE
  LowPriorityIo: BOOL   // BOOL
): Integer; stdcall;
  external 'fhsvcctl.dll' name 'FhServiceStartBackup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FhServiceStartBackup"
  c_FhServiceStartBackup :: Ptr () -> CInt -> IO Int32
-- Pipe : FH_SERVICE_PIPE_HANDLE -> Ptr ()
-- LowPriorityIo : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let fhservicestartbackup =
  foreign "FhServiceStartBackup"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* Pipe : FH_SERVICE_PIPE_HANDLE -> (ptr void) *)
(* LowPriorityIo : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library fhsvcctl (t "fhsvcctl.dll"))
(cffi:use-foreign-library fhsvcctl)

(cffi:defcfun ("FhServiceStartBackup" fh-service-start-backup :convention :stdcall) :int32
  (pipe :pointer)   ; FH_SERVICE_PIPE_HANDLE
  (low-priority-io :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FhServiceStartBackup = Win32::API::More->new('fhsvcctl',
    'int FhServiceStartBackup(HANDLE Pipe, BOOL LowPriorityIo)');
# my $ret = $FhServiceStartBackup->Call($Pipe, $LowPriorityIo);
# Pipe : FH_SERVICE_PIPE_HANDLE -> HANDLE
# LowPriorityIo : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。