Win32 API 日本語リファレンス
ホームDevices.DeviceAndDriverInstallation › FILEPATHS_A

FILEPATHS_A

構造体
サイズx64: 24 バイト / x86: 16 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
TargetLPSTR8/4+0+0ターゲットファイルへのパスです。
SourceLPSTR8/4+8+4ソースファイルへのパスです。このメンバーは、 FILEPATHS 構造体がファイルの削除操作で使用される場合には使用されません。
Win32ErrorDWORD4+16+8エラーが発生した場合、このメンバーは システムエラーコード になります。エラーが発生していない場合は NO_ERROR です。
FlagsDWORD4+20+12

FILEPATHS 構造体と共に送信される通知に応じた追加情報です。

SPFILENOTIFY_COPYERROR 通知の場合、Flags はダイアログボックスの動作を指定し、次のいずれかの値を取ります。

意味
SP_COPY_NOBROWSE
ユーザーに参照 (ブラウズ) の選択肢を提供しません。
SP_COPY_NOSKIP
ユーザーにファイルをスキップする選択肢を提供しません。
SP_COPY_WARNIFSKIP
ファイルをスキップするとインストールに影響する可能性があることをユーザーに通知します。

SPFILENOTIFY_FILEOPDELAYED 通知の場合、Flags は遅延されたファイル操作の種類を指定し、次のいずれかの値を取ります。

意味
FILEOP_COPY
ファイルのコピー操作が遅延されました。
FILEOP_DELETE
ファイルの削除操作が遅延されました。

公式ドキュメント

FILEPATHS 構造体は、コピー元とコピー先のパス情報を格納します。セットアップ関数は、コールバックルーチンに送信されるいくつかの通知のパラメーターとして FILEPATHS 構造体を渡します。詳細については、 Notifications を参照してください。

解説(Remarks)

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FILEPATHS を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存するコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での定義

#include <windows.h>

// FILEPATHS_A  (x64 24 / x86 16 バイト)
#pragma pack(push, 1)
typedef struct FILEPATHS_A {
    LPSTR Target;
    LPSTR Source;
    DWORD Win32Error;
    DWORD Flags;
} FILEPATHS_A;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct FILEPATHS_A
{
    public IntPtr Target;
    public IntPtr Source;
    public uint Win32Error;
    public uint Flags;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure FILEPATHS_A
    Public Target As IntPtr
    Public Source As IntPtr
    Public Win32Error As UInteger
    Public Flags As UInteger
End Structure
import ctypes
from ctypes import wintypes

class FILEPATHS_A(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("Target", ctypes.c_void_p),
        ("Source", ctypes.c_void_p),
        ("Win32Error", wintypes.DWORD),
        ("Flags", wintypes.DWORD),
    ]
#[repr(C, packed(1))]
pub struct FILEPATHS_A {
    pub Target: *mut core::ffi::c_void,
    pub Source: *mut core::ffi::c_void,
    pub Win32Error: u32,
    pub Flags: u32,
}
import "golang.org/x/sys/windows"

type FILEPATHS_A struct {
	Target uintptr
	Source uintptr
	Win32Error uint32
	Flags uint32
}
type
  FILEPATHS_A = packed record
    Target: Pointer;
    Source: Pointer;
    Win32Error: DWORD;
    Flags: DWORD;
  end;
const FILEPATHS_A = extern struct {
    Target: ?*anyopaque,
    Source: ?*anyopaque,
    Win32Error: u32,
    Flags: u32,
};
type
  FILEPATHS_A {.packed.} = object
    Target: pointer
    Source: pointer
    Win32Error: uint32
    Flags: uint32
align(1)
struct FILEPATHS_A
{
    void* Target;
    void* Source;
    uint Win32Error;
    uint Flags;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; FILEPATHS_A サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; Target : LPSTR (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Source : LPSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Win32Error : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Flags : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; FILEPATHS_A サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; Target : LPSTR (+0, 8byte)  qpoke st,0,値 / qpeek(st,0)  ※IronHSPのみ。3.7/3.8は lpoke st,0,下位 : lpoke st,4,上位
; Source : LPSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; Win32Error : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; Flags : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global FILEPATHS_A, pack=1
    #field intptr Target
    #field intptr Source
    #field int Win32Error
    #field int Flags
#endstruct

stdim st, FILEPATHS_A        ; NSTRUCT 変数を確保
st->Win32Error = 100
mes "Win32Error=" + st->Win32Error