Win32 API 日本語リファレンス
ホームSystem.WindowsProgramming › AddDelBackupEntryW

AddDelBackupEntryW

関数
バックアップ一覧へのエントリ追加・削除を行う(Unicode版)。
DLLADVPACK.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// ADVPACK.dll  (Unicode / -W)
#include <windows.h>

HRESULT AddDelBackupEntryW(
    LPCWSTR lpcszFileList,   // optional
    LPCWSTR lpcszBackupDir,   // optional
    LPCWSTR lpcszBaseName,   // optional
    DWORD dwFlags
);

パラメーター

名前方向説明
lpcszFileListLPCWSTRinoptionalバックアップ管理対象のファイル名リストを指す。
lpcszBackupDirLPCWSTRinoptionalバックアップを格納するディレクトリを指す。NULL可。
lpcszBaseNameLPCWSTRinoptionalバックアップを識別するベース名を指す。
dwFlagsDWORDinエントリの追加か削除かを指定するフラグ(AADBE_系)。

戻り値の型: HRESULT

各言語での呼び出し定義

// ADVPACK.dll  (Unicode / -W)
#include <windows.h>

HRESULT AddDelBackupEntryW(
    LPCWSTR lpcszFileList,   // optional
    LPCWSTR lpcszBackupDir,   // optional
    LPCWSTR lpcszBaseName,   // optional
    DWORD dwFlags
);
[DllImport("ADVPACK.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int AddDelBackupEntryW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpcszFileList,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpcszBackupDir,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpcszBaseName,   // LPCWSTR optional
    uint dwFlags   // DWORD
);
<DllImport("ADVPACK.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function AddDelBackupEntryW(
    <MarshalAs(UnmanagedType.LPWStr)> lpcszFileList As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpcszBackupDir As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpcszBaseName As String,   ' LPCWSTR optional
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' lpcszFileList : LPCWSTR optional
' lpcszBackupDir : LPCWSTR optional
' lpcszBaseName : LPCWSTR optional
' dwFlags : DWORD
Declare PtrSafe Function AddDelBackupEntryW Lib "advpack" ( _
    ByVal lpcszFileList As LongPtr, _
    ByVal lpcszBackupDir As LongPtr, _
    ByVal lpcszBaseName As LongPtr, _
    ByVal dwFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AddDelBackupEntryW = ctypes.windll.advpack.AddDelBackupEntryW
AddDelBackupEntryW.restype = ctypes.c_int
AddDelBackupEntryW.argtypes = [
    wintypes.LPCWSTR,  # lpcszFileList : LPCWSTR optional
    wintypes.LPCWSTR,  # lpcszBackupDir : LPCWSTR optional
    wintypes.LPCWSTR,  # lpcszBaseName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVPACK.dll')
AddDelBackupEntryW = Fiddle::Function.new(
  lib['AddDelBackupEntryW'],
  [
    Fiddle::TYPE_VOIDP,  # lpcszFileList : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpcszBackupDir : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpcszBaseName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advpack")]
extern "system" {
    fn AddDelBackupEntryW(
        lpcszFileList: *const u16,  // LPCWSTR optional
        lpcszBackupDir: *const u16,  // LPCWSTR optional
        lpcszBaseName: *const u16,  // LPCWSTR optional
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVPACK.dll", CharSet = CharSet.Unicode)]
public static extern int AddDelBackupEntryW([MarshalAs(UnmanagedType.LPWStr)] string lpcszFileList, [MarshalAs(UnmanagedType.LPWStr)] string lpcszBackupDir, [MarshalAs(UnmanagedType.LPWStr)] string lpcszBaseName, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVPACK_AddDelBackupEntryW' -Namespace Win32 -PassThru
# $api::AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
#uselib "ADVPACK.dll"
#func global AddDelBackupEntryW "AddDelBackupEntryW" wptr, wptr, wptr, wptr
; AddDelBackupEntryW lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags   ; 戻り値は stat
; lpcszFileList : LPCWSTR optional -> "wptr"
; lpcszBackupDir : LPCWSTR optional -> "wptr"
; lpcszBaseName : LPCWSTR optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVPACK.dll"
#cfunc global AddDelBackupEntryW "AddDelBackupEntryW" wstr, wstr, wstr, int
; res = AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
; lpcszFileList : LPCWSTR optional -> "wstr"
; lpcszBackupDir : LPCWSTR optional -> "wstr"
; lpcszBaseName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; HRESULT AddDelBackupEntryW(LPCWSTR lpcszFileList, LPCWSTR lpcszBackupDir, LPCWSTR lpcszBaseName, DWORD dwFlags)
#uselib "ADVPACK.dll"
#cfunc global AddDelBackupEntryW "AddDelBackupEntryW" wstr, wstr, wstr, int
; res = AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
; lpcszFileList : LPCWSTR optional -> "wstr"
; lpcszBackupDir : LPCWSTR optional -> "wstr"
; lpcszBaseName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advpack = windows.NewLazySystemDLL("ADVPACK.dll")
	procAddDelBackupEntryW = advpack.NewProc("AddDelBackupEntryW")
)

// lpcszFileList (LPCWSTR optional), lpcszBackupDir (LPCWSTR optional), lpcszBaseName (LPCWSTR optional), dwFlags (DWORD)
r1, _, err := procAddDelBackupEntryW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpcszFileList))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpcszBackupDir))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpcszBaseName))),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function AddDelBackupEntryW(
  lpcszFileList: PWideChar;   // LPCWSTR optional
  lpcszBackupDir: PWideChar;   // LPCWSTR optional
  lpcszBaseName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ADVPACK.dll' name 'AddDelBackupEntryW';
result := DllCall("ADVPACK\AddDelBackupEntryW"
    , "WStr", lpcszFileList   ; LPCWSTR optional
    , "WStr", lpcszBackupDir   ; LPCWSTR optional
    , "WStr", lpcszBaseName   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags) = DLL("ADVPACK.dll", "int AddDelBackupEntryW(char*, char*, char*, dword)")
# 呼び出し: AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
# lpcszFileList : LPCWSTR optional -> "char*"
# lpcszBackupDir : LPCWSTR optional -> "char*"
# lpcszBaseName : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "advpack" fn AddDelBackupEntryW(
    lpcszFileList: [*c]const u16, // LPCWSTR optional
    lpcszBackupDir: [*c]const u16, // LPCWSTR optional
    lpcszBaseName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc AddDelBackupEntryW(
    lpcszFileList: WideCString,  # LPCWSTR optional
    lpcszBackupDir: WideCString,  # LPCWSTR optional
    lpcszBaseName: WideCString,  # LPCWSTR optional
    dwFlags: uint32  # DWORD
): int32 {.importc: "AddDelBackupEntryW", stdcall, dynlib: "ADVPACK.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advpack");
extern(Windows)
int AddDelBackupEntryW(
    const(wchar)* lpcszFileList,   // LPCWSTR optional
    const(wchar)* lpcszBackupDir,   // LPCWSTR optional
    const(wchar)* lpcszBaseName,   // LPCWSTR optional
    uint dwFlags   // DWORD
);
ccall((:AddDelBackupEntryW, "ADVPACK.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring, UInt32),
      lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
# lpcszFileList : LPCWSTR optional -> Cwstring
# lpcszBackupDir : LPCWSTR optional -> Cwstring
# lpcszBaseName : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t AddDelBackupEntryW(
    const uint16_t* lpcszFileList,
    const uint16_t* lpcszBackupDir,
    const uint16_t* lpcszBaseName,
    uint32_t dwFlags);
]]
local advpack = ffi.load("advpack")
-- advpack.AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
-- lpcszFileList : LPCWSTR optional
-- lpcszBackupDir : LPCWSTR optional
-- lpcszBaseName : LPCWSTR optional
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVPACK.dll');
const AddDelBackupEntryW = lib.func('__stdcall', 'AddDelBackupEntryW', 'int32_t', ['str16', 'str16', 'str16', 'uint32_t']);
// AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
// lpcszFileList : LPCWSTR optional -> 'str16'
// lpcszBackupDir : LPCWSTR optional -> 'str16'
// lpcszBaseName : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVPACK.dll", {
  AddDelBackupEntryW: { parameters: ["buffer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags)
// lpcszFileList : LPCWSTR optional -> "buffer"
// lpcszBackupDir : LPCWSTR optional -> "buffer"
// lpcszBaseName : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AddDelBackupEntryW(
    const uint16_t* lpcszFileList,
    const uint16_t* lpcszBackupDir,
    const uint16_t* lpcszBaseName,
    uint32_t dwFlags);
C, "ADVPACK.dll");
// $ffi->AddDelBackupEntryW(lpcszFileList, lpcszBackupDir, lpcszBaseName, dwFlags);
// lpcszFileList : LPCWSTR optional
// lpcszBackupDir : LPCWSTR optional
// lpcszBaseName : LPCWSTR optional
// dwFlags : DWORD
// 構造体/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 Advpack extends StdCallLibrary {
    Advpack INSTANCE = Native.load("advpack", Advpack.class, W32APIOptions.UNICODE_OPTIONS);
    int AddDelBackupEntryW(
        WString lpcszFileList,   // LPCWSTR optional
        WString lpcszBackupDir,   // LPCWSTR optional
        WString lpcszBaseName,   // LPCWSTR optional
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advpack")]
lib LibADVPACK
  fun AddDelBackupEntryW = AddDelBackupEntryW(
    lpcszFileList : UInt16*,   # LPCWSTR optional
    lpcszBackupDir : UInt16*,   # LPCWSTR optional
    lpcszBaseName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AddDelBackupEntryWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef AddDelBackupEntryWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final AddDelBackupEntryW = DynamicLibrary.open('ADVPACK.dll')
    .lookupFunction<AddDelBackupEntryWNative, AddDelBackupEntryWDart>('AddDelBackupEntryW');
// lpcszFileList : LPCWSTR optional -> Pointer<Utf16>
// lpcszBackupDir : LPCWSTR optional -> Pointer<Utf16>
// lpcszBaseName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AddDelBackupEntryW(
  lpcszFileList: PWideChar;   // LPCWSTR optional
  lpcszBackupDir: PWideChar;   // LPCWSTR optional
  lpcszBaseName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'ADVPACK.dll' name 'AddDelBackupEntryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AddDelBackupEntryW"
  c_AddDelBackupEntryW :: CWString -> CWString -> CWString -> Word32 -> IO Int32
-- lpcszFileList : LPCWSTR optional -> CWString
-- lpcszBackupDir : LPCWSTR optional -> CWString
-- lpcszBaseName : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let adddelbackupentryw =
  foreign "AddDelBackupEntryW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* lpcszFileList : LPCWSTR optional -> (ptr uint16_t) *)
(* lpcszBackupDir : LPCWSTR optional -> (ptr uint16_t) *)
(* lpcszBaseName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advpack (t "ADVPACK.dll"))
(cffi:use-foreign-library advpack)

(cffi:defcfun ("AddDelBackupEntryW" add-del-backup-entry-w :convention :stdcall) :int32
  (lpcsz-file-list (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lpcsz-backup-dir (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lpcsz-base-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AddDelBackupEntryW = Win32::API::More->new('ADVPACK',
    'int AddDelBackupEntryW(LPCWSTR lpcszFileList, LPCWSTR lpcszBackupDir, LPCWSTR lpcszBaseName, DWORD dwFlags)');
# my $ret = $AddDelBackupEntryW->Call($lpcszFileList, $lpcszBackupDir, $lpcszBaseName, $dwFlags);
# lpcszFileList : LPCWSTR optional -> LPCWSTR
# lpcszBackupDir : LPCWSTR optional -> LPCWSTR
# lpcszBaseName : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い