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

WofWimSuspendEntry

関数
WIM圧縮データソースのエントリを一時停止する。
DLLWOFUTIL.dll呼出規約winapi

シグネチャ

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

HRESULT WofWimSuspendEntry(
    LPCWSTR VolumeName,
    LONGLONG DataSourceId
);

パラメーター

名前方向説明
VolumeNameLPCWSTRinWIM によってデータが提供されたファイルを格納していたボリューム名。
DataSourceIdLONGLONGinWIM エントリを識別します。

戻り値の型: HRESULT

公式ドキュメント

WIM データソースを、ボリュームが再マウントされるか、データソースが WofWimUpdateEntry で更新されるまで、ボリューム上のバッキングファイルから一時的に削除します。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

WIM ファイルからデータが派生したファイルが現在ボリュームに存在する場合、それらのファイルのデータは一時的にアクセス不能になります。システムが現在動作している WIM に対しては、この操作を実行しないでください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT WofWimSuspendEntry(
    LPCWSTR VolumeName,
    LONGLONG DataSourceId
);
[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern int WofWimSuspendEntry(
    [MarshalAs(UnmanagedType.LPWStr)] string VolumeName,   // LPCWSTR
    long DataSourceId   // LONGLONG
);
<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofWimSuspendEntry(
    <MarshalAs(UnmanagedType.LPWStr)> VolumeName As String,   ' LPCWSTR
    DataSourceId As Long   ' LONGLONG
) As Integer
End Function
' VolumeName : LPCWSTR
' DataSourceId : LONGLONG
Declare PtrSafe Function WofWimSuspendEntry Lib "wofutil" ( _
    ByVal VolumeName As LongPtr, _
    ByVal DataSourceId As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WofWimSuspendEntry = ctypes.windll.wofutil.WofWimSuspendEntry
WofWimSuspendEntry.restype = ctypes.c_int
WofWimSuspendEntry.argtypes = [
    wintypes.LPCWSTR,  # VolumeName : LPCWSTR
    ctypes.c_longlong,  # DataSourceId : LONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WOFUTIL.dll')
WofWimSuspendEntry = Fiddle::Function.new(
  lib['WofWimSuspendEntry'],
  [
    Fiddle::TYPE_VOIDP,  # VolumeName : LPCWSTR
    Fiddle::TYPE_LONG_LONG,  # DataSourceId : LONGLONG
  ],
  Fiddle::TYPE_INT)
#[link(name = "wofutil")]
extern "system" {
    fn WofWimSuspendEntry(
        VolumeName: *const u16,  // LPCWSTR
        DataSourceId: i64  // LONGLONG
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WOFUTIL.dll")]
public static extern int WofWimSuspendEntry([MarshalAs(UnmanagedType.LPWStr)] string VolumeName, long DataSourceId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofWimSuspendEntry' -Namespace Win32 -PassThru
# $api::WofWimSuspendEntry(VolumeName, DataSourceId)
#uselib "WOFUTIL.dll"
#func global WofWimSuspendEntry "WofWimSuspendEntry" sptr, sptr
; WofWimSuspendEntry VolumeName, DataSourceId   ; 戻り値は stat
; VolumeName : LPCWSTR -> "sptr"
; DataSourceId : LONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WOFUTIL.dll"
#cfunc global WofWimSuspendEntry "WofWimSuspendEntry" wstr, int64
; res = WofWimSuspendEntry(VolumeName, DataSourceId)
; VolumeName : LPCWSTR -> "wstr"
; DataSourceId : LONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT WofWimSuspendEntry(LPCWSTR VolumeName, LONGLONG DataSourceId)
#uselib "WOFUTIL.dll"
#cfunc global WofWimSuspendEntry "WofWimSuspendEntry" wstr, int64
; res = WofWimSuspendEntry(VolumeName, DataSourceId)
; VolumeName : LPCWSTR -> "wstr"
; DataSourceId : LONGLONG -> "int64"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
	procWofWimSuspendEntry = wofutil.NewProc("WofWimSuspendEntry")
)

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

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

typedef WofWimSuspendEntryNative = Int32 Function(Pointer<Utf16>, Int64);
typedef WofWimSuspendEntryDart = int Function(Pointer<Utf16>, int);
final WofWimSuspendEntry = DynamicLibrary.open('WOFUTIL.dll')
    .lookupFunction<WofWimSuspendEntryNative, WofWimSuspendEntryDart>('WofWimSuspendEntry');
// VolumeName : LPCWSTR -> Pointer<Utf16>
// DataSourceId : LONGLONG -> Int64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WofWimSuspendEntry(
  VolumeName: PWideChar;   // LPCWSTR
  DataSourceId: Int64   // LONGLONG
): Integer; stdcall;
  external 'WOFUTIL.dll' name 'WofWimSuspendEntry';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WofWimSuspendEntry"
  c_WofWimSuspendEntry :: CWString -> Int64 -> IO Int32
-- VolumeName : LPCWSTR -> CWString
-- DataSourceId : LONGLONG -> Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wofwimsuspendentry =
  foreign "WofWimSuspendEntry"
    ((ptr uint16_t) @-> int64_t @-> returning int32_t)
(* VolumeName : LPCWSTR -> (ptr uint16_t) *)
(* DataSourceId : LONGLONG -> int64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wofutil (t "WOFUTIL.dll"))
(cffi:use-foreign-library wofutil)

(cffi:defcfun ("WofWimSuspendEntry" wof-wim-suspend-entry :convention :stdcall) :int32
  (volume-name (:string :encoding :utf-16le))   ; LPCWSTR
  (data-source-id :int64))   ; LONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WofWimSuspendEntry = Win32::API::More->new('WOFUTIL',
    'int WofWimSuspendEntry(LPCWSTR VolumeName, INT64 DataSourceId)');
# my $ret = $WofWimSuspendEntry->Call($VolumeName, $DataSourceId);
# VolumeName : LPCWSTR -> LPCWSTR
# DataSourceId : LONGLONG -> INT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。