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

COPYFILE2_MESSAGE

構造体
サイズx64: 16 バイト / x86: 12 バイト

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

フィールド

フィールドサイズx64x86説明
TypeCOPYFILE2_MESSAGE_TYPE4+0+0

COPYFILE2_MESSAGE_TYPE 列挙型の値で、この構造体内の Info 共用体の判別子として使用されます。

意味
COPYFILE2_CALLBACK_CHUNK_STARTED
1
ストリーム内の 1 つのチャンクのコピーが開始されたことを示します。情報は Info 共用体内の ChunkStarted 構造体に格納されます。
COPYFILE2_CALLBACK_CHUNK_FINISHED
2
ストリーム内の 1 つのチャンクのコピーが完了したことを示します。情報は Info 共用体内の ChunkFinished 構造体に格納されます。
COPYFILE2_CALLBACK_STREAM_STARTED
3
ストリームのコピー元とコピー先の両方のハンドルが開かれ、そのストリームのコピーが開始されようとしていることを示します。情報は Info 共用体内の StreamStarted 構造体に格納されます。これは、そのストリームのコピーが開始されたことを示すものではありません。
COPYFILE2_CALLBACK_STREAM_FINISHED
4
ストリームのコピー操作が、正常に、または CopyFile2ProgressRoutineCOPYFILE2_PROGRESS_STOP を返したことにより、完了し始めたことを示します。情報は Info 共用体内の StreamFinished 構造体に格納されます。
COPYFILE2_CALLBACK_POLL_CONTINUE
5
定期的に送信されることがあります。情報は Info 共用体内の PollContinue 構造体に格納されます。
COPYFILE2_CALLBACK_ERROR
6
コピー操作中にエラーが発生しました。情報は Info 共用体内の Error 構造体に格納されます。
dwPaddingDWORD4+4+4アラインメント調整用のパディング。
Info_Info_e__Union8/4+8+8メッセージ種類に応じた詳細情報を保持する共用体。

共用体: _Info_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
ChunkStarted_ChunkStarted_e__Struct8/4+0+0この構造体は、Type メンバーが COPYFILE2_CALLBACK_CHUNK_STARTED (1) に設定されている場合に選択されます。
ChunkFinished_ChunkFinished_e__Struct8/4+0+0

この構造体は、Type メンバーが COPYFILE2_CALLBACK_CHUNK_FINISHED (2) に設定されている場合に選択されます。

ChunkFinished.dwReserved

このメンバーは内部使用のために予約済みです。

StreamStarted_StreamStarted_e__Struct8/4+0+0この構造体は、Type メンバーが COPYFILE2_CALLBACK_STREAM_STARTED (3) に設定されている場合に選択されます。
StreamFinished_StreamFinished_e__Struct8/4+0+0この構造体は、Type メンバーが COPYFILE2_CALLBACK_STREAM_FINISHED (4) に設定されている場合に選択されます。
PollContinue_PollContinue_e__Struct8/4+0+0この構造体は、Type メンバーが COPYFILE2_CALLBACK_POLL_CONTNUE (5) に設定されている場合に選択されます。
Error_Error_e__Struct8/4+0+0この構造体は、Type メンバーが COPYFILE2_CALLBACK_ERROR (6) に設定されている場合に選択されます。

公式ドキュメント

<a href="/windows/desktop/api/winbase/nc-winbase-pcopyfile2_progress_routine">CopyFile2ProgressRoutine</a> コールバック関数に渡され、
保留中のコピー操作に関する情報を提供します。

解説(Remarks)

COPYFILE2_MESSAGE 構造体を使用するアプリケーションをコンパイルするには、 _WIN32_WINNT マクロを 0x0601 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

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

各言語での定義

#include <windows.h>

// COPYFILE2_MESSAGE  (x64 16 / x86 12 バイト)
typedef struct COPYFILE2_MESSAGE {
    COPYFILE2_MESSAGE_TYPE Type;
    DWORD dwPadding;
    _Info_e__Union Info;
} COPYFILE2_MESSAGE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct COPYFILE2_MESSAGE
{
    public int Type;
    public uint dwPadding;
    public _Info_e__Union Info;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure COPYFILE2_MESSAGE
    Public Type As Integer
    Public dwPadding As UInteger
    Public Info As _Info_e__Union
End Structure
import ctypes
from ctypes import wintypes

class COPYFILE2_MESSAGE(ctypes.Structure):
    _fields_ = [
        ("Type", ctypes.c_int),
        ("dwPadding", wintypes.DWORD),
        ("Info", _Info_e__Union),
    ]
#[repr(C)]
pub struct COPYFILE2_MESSAGE {
    pub Type: i32,
    pub dwPadding: u32,
    pub Info: _Info_e__Union,
}
import "golang.org/x/sys/windows"

type COPYFILE2_MESSAGE struct {
	Type int32
	dwPadding uint32
	Info _Info_e__Union
}
type
  COPYFILE2_MESSAGE = record
    Type: Integer;
    dwPadding: DWORD;
    Info: _Info_e__Union;
  end;
const COPYFILE2_MESSAGE = extern struct {
    Type: i32,
    dwPadding: u32,
    Info: _Info_e__Union,
};
type
  COPYFILE2_MESSAGE {.bycopy.} = object
    Type: int32
    dwPadding: uint32
    Info: _Info_e__Union
struct COPYFILE2_MESSAGE
{
    int Type;
    uint dwPadding;
    _Info_e__Union Info;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; COPYFILE2_MESSAGE サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; Type : COPYFILE2_MESSAGE_TYPE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwPadding : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Info : _Info_e__Union (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; COPYFILE2_MESSAGE サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; Type : COPYFILE2_MESSAGE_TYPE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwPadding : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Info : _Info_e__Union (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global COPYFILE2_MESSAGE
    #field int Type
    #field int dwPadding
    #field byte Info 8
#endstruct

stdim st, COPYFILE2_MESSAGE        ; NSTRUCT 変数を確保
st->Type = 100
mes "Type=" + st->Type
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。