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

VSS_SNAPSHOT_PROP

構造体
サイズx64: 128 バイト / x86: 96 バイト

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

フィールド

フィールドサイズx64x86説明
m_SnapshotIdGUID16+0+0シャドウ コピー識別子を一意に識別する VSS_ID (GUID) です。
m_SnapshotSetIdGUID16+16+16そのシャドウ コピーを含むシャドウ コピー セットを一意に識別する VSS_ID (GUID) です。
m_lSnapshotsCountINT4+32+32

シャドウ コピー セットの作成時に、そのシャドウ コピーと共に含められたボリュームの数です。アプリケーションはシャドウ コピー セットを解放せずに個々のシャドウ コピーを解放できるため、任意の時点でシャドウ コピー セット内のシャドウ コピーの数が m_LSnapshotsCount より少なくなる場合があります。

シャドウ コピー セットに含めることができるシャドウ コピー対象ボリュームの最大数は 64 です。

m_pwszSnapshotDeviceObjectWORD*8/4+40+36

ボリュームのシャドウ コピーに対するデバイス オブジェクトの名前を格納する、null で終わるワイド文字列です。デバイス オブジェクトは、ボリュームのシャドウ コピーのルートと考えることができます。要求元 (リクエスター) は、シャドウ コピーされたボリューム上の操作対象のファイルにアクセスする際に、このデバイス名を使用します。

デバイス名の末尾に "" は付きません。

m_pwszOriginalVolumeNameWORD*8/4+48+40シャドウ コピーされたボリュームの名前を格納する、null で終わるワイド文字列です。
m_pwszOriginatingMachineWORD*8/4+56+44元のボリュームが存在するコンピューターの名前を格納する、null で終わるワイド文字列です。
m_pwszServiceMachineWORD*8/4+64+48シャドウ コピーを作成したボリューム シャドウ コピー サービスが実行されているコンピューターの名前を格納する、null で終わるワイド文字列です。
m_pwszExposedNameWORD*8/4+72+52シャドウ コピーが公開されているときの名前を格納する、null で終わるワイド文字列です。これは、(シャドウ コピーがローカル ボリュームとして公開されている場合は) ドライブ文字またはマウントされたフォルダー、あるいは共有名です。IVssBackupComponents::ExposeSnapshot メソッドの wszExpose パラメーターに対応します。
m_pwszExposedPathWORD*8/4+80+56共有として公開されている場合に利用可能となる、ボリュームのシャドウ コピーの一部分を示す、null で終わるワイド文字列です。IVssBackupComponents::ExposeSnapshot メソッドの wszPathFromRoot パラメーターに対応します。
m_ProviderIdGUID16+88+60このシャドウ コピーの作成に使用されたプロバイダーを一意に識別する VSS_ID (GUID) です。
m_lSnapshotAttributesINT4+104+76シャドウ コピーの属性。_VSS_VOLUME_SNAPSHOT_ATTRIBUTES 列挙型のメンバーのビット マスク (ビット単位のOR) として表されます。
m_tsCreationTimestampLONGLONG8+112+80シャドウ コピーが作成された日時を示すタイム スタンプです。正確な時刻はプロバイダーによって決定されます。タイム スタンプの形式については、VSS_TIMESTAMP を参照してください。
m_eStatusVSS_SNAPSHOT_STATE4+120+88現在のシャドウ コピーの作成状態です。VSS_SNAPSHOT_STATE を参照してください。

公式ドキュメント

VSS_SNAPSHOT_PROP 構造体は、シャドウ コピーまたはシャドウ コピー セットのプロパティを格納します。

解説(Remarks)

要求元 (リクエスター) は通常、IVssBackupComponents::GetSnapshotProperties メソッドまたは IVssSoftwareSnapshotProvider::GetSnapshotProperties メソッドを使用して、VSS_SNAPSHOT_PROP 構造体へのポインターを取得します。この構造体が不要になったら、呼び出し元は VssFreeSnapshotProperties 関数を使用して解放する必要があります。

m_pwszSnapshotDeviceObject に格納されるシャドウ コピー デバイス オブジェクトは、ボリュームのシャドウ コピー上のファイルを指定するために使用されます。たとえば、元のボリュームに "\topleveldir\File.html" というパスのファイルがある場合、そのファイルのシャドウ コピーへのパスは "m_pwszSnapshotDeviceObject"+"\topleveldir\File.html" となります。

シャドウ コピーが共有として公開されている場合、m_pwszExposedName の値は共有名になります。シャドウ コピーがドライブ文字またはマウントされたフォルダーとして公開されている場合、m_pwszExposedName はドライブ文字の後にコロンが続く形式 (たとえば "X:")、またはマウントされたフォルダーのパス (たとえば "Y:\MountX") になります。

シャドウ コピーがドライブ文字またはマウントされたフォルダーとして公開されている場合は、(デバイスをマウントする場合と同様に) ルートから始まるシャドウ コピー全体がマウント ポイントに公開されます。この場合、m_pwszExposedPath は null になります。

シャドウ コピーが共有として公開されている場合、m_pwszExposedPath の値は、共有されているボリューム部分へのパスになります。

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

各言語での定義

#include <windows.h>

// VSS_SNAPSHOT_PROP  (x64 128 / x86 96 バイト)
typedef struct VSS_SNAPSHOT_PROP {
    GUID m_SnapshotId;
    GUID m_SnapshotSetId;
    INT m_lSnapshotsCount;
    WORD* m_pwszSnapshotDeviceObject;
    WORD* m_pwszOriginalVolumeName;
    WORD* m_pwszOriginatingMachine;
    WORD* m_pwszServiceMachine;
    WORD* m_pwszExposedName;
    WORD* m_pwszExposedPath;
    GUID m_ProviderId;
    INT m_lSnapshotAttributes;
    LONGLONG m_tsCreationTimestamp;
    VSS_SNAPSHOT_STATE m_eStatus;
} VSS_SNAPSHOT_PROP;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct VSS_SNAPSHOT_PROP
{
    public Guid m_SnapshotId;
    public Guid m_SnapshotSetId;
    public int m_lSnapshotsCount;
    public IntPtr m_pwszSnapshotDeviceObject;
    public IntPtr m_pwszOriginalVolumeName;
    public IntPtr m_pwszOriginatingMachine;
    public IntPtr m_pwszServiceMachine;
    public IntPtr m_pwszExposedName;
    public IntPtr m_pwszExposedPath;
    public Guid m_ProviderId;
    public int m_lSnapshotAttributes;
    public long m_tsCreationTimestamp;
    public int m_eStatus;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure VSS_SNAPSHOT_PROP
    Public m_SnapshotId As Guid
    Public m_SnapshotSetId As Guid
    Public m_lSnapshotsCount As Integer
    Public m_pwszSnapshotDeviceObject As IntPtr
    Public m_pwszOriginalVolumeName As IntPtr
    Public m_pwszOriginatingMachine As IntPtr
    Public m_pwszServiceMachine As IntPtr
    Public m_pwszExposedName As IntPtr
    Public m_pwszExposedPath As IntPtr
    Public m_ProviderId As Guid
    Public m_lSnapshotAttributes As Integer
    Public m_tsCreationTimestamp As Long
    Public m_eStatus As Integer
End Structure
import ctypes
from ctypes import wintypes

class VSS_SNAPSHOT_PROP(ctypes.Structure):
    _fields_ = [
        ("m_SnapshotId", GUID),
        ("m_SnapshotSetId", GUID),
        ("m_lSnapshotsCount", ctypes.c_int),
        ("m_pwszSnapshotDeviceObject", ctypes.c_void_p),
        ("m_pwszOriginalVolumeName", ctypes.c_void_p),
        ("m_pwszOriginatingMachine", ctypes.c_void_p),
        ("m_pwszServiceMachine", ctypes.c_void_p),
        ("m_pwszExposedName", ctypes.c_void_p),
        ("m_pwszExposedPath", ctypes.c_void_p),
        ("m_ProviderId", GUID),
        ("m_lSnapshotAttributes", ctypes.c_int),
        ("m_tsCreationTimestamp", ctypes.c_longlong),
        ("m_eStatus", ctypes.c_int),
    ]
#[repr(C)]
pub struct VSS_SNAPSHOT_PROP {
    pub m_SnapshotId: GUID,
    pub m_SnapshotSetId: GUID,
    pub m_lSnapshotsCount: i32,
    pub m_pwszSnapshotDeviceObject: *mut core::ffi::c_void,
    pub m_pwszOriginalVolumeName: *mut core::ffi::c_void,
    pub m_pwszOriginatingMachine: *mut core::ffi::c_void,
    pub m_pwszServiceMachine: *mut core::ffi::c_void,
    pub m_pwszExposedName: *mut core::ffi::c_void,
    pub m_pwszExposedPath: *mut core::ffi::c_void,
    pub m_ProviderId: GUID,
    pub m_lSnapshotAttributes: i32,
    pub m_tsCreationTimestamp: i64,
    pub m_eStatus: i32,
}
import "golang.org/x/sys/windows"

type VSS_SNAPSHOT_PROP struct {
	m_SnapshotId windows.GUID
	m_SnapshotSetId windows.GUID
	m_lSnapshotsCount int32
	m_pwszSnapshotDeviceObject uintptr
	m_pwszOriginalVolumeName uintptr
	m_pwszOriginatingMachine uintptr
	m_pwszServiceMachine uintptr
	m_pwszExposedName uintptr
	m_pwszExposedPath uintptr
	m_ProviderId windows.GUID
	m_lSnapshotAttributes int32
	m_tsCreationTimestamp int64
	m_eStatus int32
}
type
  VSS_SNAPSHOT_PROP = record
    m_SnapshotId: TGUID;
    m_SnapshotSetId: TGUID;
    m_lSnapshotsCount: Integer;
    m_pwszSnapshotDeviceObject: Pointer;
    m_pwszOriginalVolumeName: Pointer;
    m_pwszOriginatingMachine: Pointer;
    m_pwszServiceMachine: Pointer;
    m_pwszExposedName: Pointer;
    m_pwszExposedPath: Pointer;
    m_ProviderId: TGUID;
    m_lSnapshotAttributes: Integer;
    m_tsCreationTimestamp: Int64;
    m_eStatus: Integer;
  end;
const VSS_SNAPSHOT_PROP = extern struct {
    m_SnapshotId: GUID,
    m_SnapshotSetId: GUID,
    m_lSnapshotsCount: i32,
    m_pwszSnapshotDeviceObject: ?*anyopaque,
    m_pwszOriginalVolumeName: ?*anyopaque,
    m_pwszOriginatingMachine: ?*anyopaque,
    m_pwszServiceMachine: ?*anyopaque,
    m_pwszExposedName: ?*anyopaque,
    m_pwszExposedPath: ?*anyopaque,
    m_ProviderId: GUID,
    m_lSnapshotAttributes: i32,
    m_tsCreationTimestamp: i64,
    m_eStatus: i32,
};
type
  VSS_SNAPSHOT_PROP {.bycopy.} = object
    m_SnapshotId: GUID
    m_SnapshotSetId: GUID
    m_lSnapshotsCount: int32
    m_pwszSnapshotDeviceObject: pointer
    m_pwszOriginalVolumeName: pointer
    m_pwszOriginatingMachine: pointer
    m_pwszServiceMachine: pointer
    m_pwszExposedName: pointer
    m_pwszExposedPath: pointer
    m_ProviderId: GUID
    m_lSnapshotAttributes: int32
    m_tsCreationTimestamp: int64
    m_eStatus: int32
struct VSS_SNAPSHOT_PROP
{
    GUID m_SnapshotId;
    GUID m_SnapshotSetId;
    int m_lSnapshotsCount;
    void* m_pwszSnapshotDeviceObject;
    void* m_pwszOriginalVolumeName;
    void* m_pwszOriginatingMachine;
    void* m_pwszServiceMachine;
    void* m_pwszExposedName;
    void* m_pwszExposedPath;
    GUID m_ProviderId;
    int m_lSnapshotAttributes;
    long m_tsCreationTimestamp;
    int m_eStatus;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; VSS_SNAPSHOT_PROP サイズ: 96 バイト(x86)
dim st, 24    ; 4byte整数×24(構造体サイズ 96 / 4 切り上げ)
; m_SnapshotId : GUID (+0, 16byte)  varptr(st)+0 を基点に操作(16byte:入れ子/配列)
; m_SnapshotSetId : GUID (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; m_lSnapshotsCount : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; m_pwszSnapshotDeviceObject : WORD* (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; m_pwszOriginalVolumeName : WORD* (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; m_pwszOriginatingMachine : WORD* (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; m_pwszServiceMachine : WORD* (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; m_pwszExposedName : WORD* (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; m_pwszExposedPath : WORD* (+56, 4byte)  st.14 = 値  /  値 = st.14   (lpoke/lpeek も可)
; m_ProviderId : GUID (+60, 16byte)  varptr(st)+60 を基点に操作(16byte:入れ子/配列)
; m_lSnapshotAttributes : INT (+76, 4byte)  st.19 = 値  /  値 = st.19   (lpoke/lpeek も可)
; m_tsCreationTimestamp : LONGLONG (+80, 8byte)  qpoke st,80,値 / qpeek(st,80)  ※IronHSPのみ。3.7/3.8は lpoke st,80,下位 : lpoke st,84,上位
; m_eStatus : VSS_SNAPSHOT_STATE (+88, 4byte)  st.22 = 値  /  値 = st.22   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; VSS_SNAPSHOT_PROP サイズ: 128 バイト(x64)
dim st, 32    ; 4byte整数×32(構造体サイズ 128 / 4 切り上げ)
; m_SnapshotId : GUID (+0, 16byte)  varptr(st)+0 を基点に操作(16byte:入れ子/配列)
; m_SnapshotSetId : GUID (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; m_lSnapshotsCount : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; m_pwszSnapshotDeviceObject : WORD* (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; m_pwszOriginalVolumeName : WORD* (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; m_pwszOriginatingMachine : WORD* (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; m_pwszServiceMachine : WORD* (+64, 8byte)  qpoke st,64,値 / qpeek(st,64)  ※IronHSPのみ。3.7/3.8は lpoke st,64,下位 : lpoke st,68,上位
; m_pwszExposedName : WORD* (+72, 8byte)  qpoke st,72,値 / qpeek(st,72)  ※IronHSPのみ。3.7/3.8は lpoke st,72,下位 : lpoke st,76,上位
; m_pwszExposedPath : WORD* (+80, 8byte)  qpoke st,80,値 / qpeek(st,80)  ※IronHSPのみ。3.7/3.8は lpoke st,80,下位 : lpoke st,84,上位
; m_ProviderId : GUID (+88, 16byte)  varptr(st)+88 を基点に操作(16byte:入れ子/配列)
; m_lSnapshotAttributes : INT (+104, 4byte)  st.26 = 値  /  値 = st.26   (lpoke/lpeek も可)
; m_tsCreationTimestamp : LONGLONG (+112, 8byte)  qpoke st,112,値 / qpeek(st,112)  ※IronHSPのみ。3.7/3.8は lpoke st,112,下位 : lpoke st,116,上位
; m_eStatus : VSS_SNAPSHOT_STATE (+120, 4byte)  st.30 = 値  /  値 = st.30   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global VSS_SNAPSHOT_PROP
    #field GUID m_SnapshotId
    #field GUID m_SnapshotSetId
    #field int m_lSnapshotsCount
    #field intptr m_pwszSnapshotDeviceObject
    #field intptr m_pwszOriginalVolumeName
    #field intptr m_pwszOriginatingMachine
    #field intptr m_pwszServiceMachine
    #field intptr m_pwszExposedName
    #field intptr m_pwszExposedPath
    #field GUID m_ProviderId
    #field int m_lSnapshotAttributes
    #field int64 m_tsCreationTimestamp
    #field int m_eStatus
#endstruct

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