IVssWMFiledesc

COM

継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IVssWMFiledesc インターフェイスは、いくつかのクエリメソッドから呼び出し元アプリケーションに返される C++(COM ではない)インターフェイスです。ファイルまたはファイルの集合(ファイルセット)に関する詳細情報を提供します。

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetPath(LPWSTR* pbstrPath)

GetPath メソッドは、現在の IVssWMFiledesc オブジェクトに記述されているファイルの一覧を取得するために、完全修飾ディレクトリパス、またはリモートファイル共有の UNC パスを取得します。

pbstrPath

LPWSTR*

out

呼び出し元が割り当てた変数のアドレスで、完全修飾ディレクトリパス、またはリモートファイル共有ディレクトリの UNC パスを指定する NULL 終端のワイド文字列を受け取ります。

このパスは長い形式または短い形式のファイル名を使用でき、プレフィックス "\?" を使用できます。詳細については、 Naming a File を参照してください。

このメソッドを使用する側は、このパスがバックスラッシュ ("") で終わっているかどうかを確認する必要があります。

戻り値

このメソッドの有効な戻り値コードは次のとおりです。

値	意味
S_OK	パス情報を正常に返しました。
E_INVALIDARG	パラメーター値のいずれかが無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、 Event and Error Handling Under VSS を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値は Windows Server 2008 R2 および Windows 7 までサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

Windows 7、Windows Server 2008 R2、Windows Vista、Windows Server 2008、Windows XP および Windows Server 2003: リモートファイル共有は Windows 8 および Windows Server 2012 までサポートされません。

呼び出し元は、pbstrPath パラメーターが保持するメモリを解放するために SysFreeString を呼び出す必要があります。

vtbl 4 HRESULT GetFilespec(LPWSTR* pbstrFilespec)

GetFilespec メソッドは、現在の IVssWMFiledesc オブジェクトがメンバーとなっているファイルの一覧を取得するために使用されるファイル指定を返します。

pbstrFilespec

LPWSTR*

out

呼び出し元が割り当てた変数のアドレスで、返されるファイル指定を表す文字列を受け取ります。

ファイル指定にはディレクトリ指定(たとえばバックスラッシュ)を含めることはできませんが、? および * のワイルドカード文字を含めることができます。

戻り値

このメソッドの有効な戻り値コードは次のとおりです。

値	意味
S_OK	ファイル指定情報を正常に返しました。
E_INVALIDARG	パラメーター値のいずれかが無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、 Event and Error Handling Under VSS を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値は Windows Server 2008 R2 および Windows 7 までサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

呼び出し元は、pbstrFilespec パラメーターが保持するメモリを解放するために SysFreeString を呼び出す必要があります。

vtbl 5 HRESULT GetRecursive(BOOLEAN* pbRecursive)

IVssWMFiledesc::GetPath が返すルートディレクトリを持つ IVssWMFiledesc オブジェクトに記述されているファイルの一覧が、そのディレクトリ内のファイルのみを含むかどうかを示します。

pbRecursive

BOOLEAN*

out

IVssWMFiledesc::GetPath が返す値が単一のディレクトリのみを示すのか、それとも再帰的にたどるディレクトリの階層を示すのかを指定する Boolean 値へのポインターです。パスが再帰的にたどるディレクトリの階層として扱われる場合、この Boolean 値は true を受け取り、そうでない場合は false を受け取ります。

マウントされたフォルダーをたどる方法については、 Working with Mounted Folders and Reparse Points を参照してください。

戻り値

このメソッドの有効な戻り値コードは次のとおりです。

値	意味
S_OK	再帰情報を正常に返しました。
E_INVALIDARG	パラメーター値のいずれかが無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、 Event and Error Handling Under VSS を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値は Windows Server 2008 R2 および Windows 7 までサポートされません。代わりに E_UNEXPECTED が使用されます。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。

vtbl 6 HRESULT GetAlternateLocation(LPWSTR* pbstrAlternateLocation)

GetAlternateLocation メソッドは、ファイルセットの代替の場所を取得します。

pbstrAlternateLocation

LPWSTR*

out

呼び出し元が割り当てた変数のアドレスで、代替バックアップの場所を表す文字列を受け取ります。この場所のパスは、ローカルパスまたはリモートファイル共有の UNC パスにすることができます。代替の場所が存在しない場合、ポインターは NULL になります。

戻り値

このメソッドの有効な戻り値コードは次のとおりです。

値	意味
S_OK	代替の場所情報を正常に返しました。
S_FALSE	要求された情報が見つかりませんでした。
E_INVALIDARG	パラメーター値のいずれかが無効です。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、 Event and Error Handling Under VSS を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値は Windows Server 2008 R2 および Windows 7 までサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

呼び出し元は、pbstrAlternateLocation パラメーターが保持するメモリを解放するために SysFreeString を呼び出す必要があります。

GetAlternateLocation が返す代替の場所の解釈は、 IVssWMFiledesc オブジェクトの取得に使用したメソッドによって異なります。

GetAlternateLocation が返す値は、 IVssExamineWriterMetadata::GetAlternateLocationMapping メソッドによって返された場合、代替の場所のマッピングを指します。

バックアップ操作中は、これはファイルのバックアップ元となる代替の場所です。復元中は、ファイルの復元先となる代替の場所です。

詳細については、 Non-Default Backup And Restore Locations を参照してください。

vtbl 7 HRESULT GetBackupTypeMask(DWORD* pdwTypeMask)

GetBackupTypeMask メソッドは、現在のファイル記述子で指定されたファイルのファイルバックアップ指定を、VSS_FILE_SPEC_BACKUP_TYPE 値のビットマスク(またはビットごとの OR)として返します。

pdwTypeMask

DWORD*

out

現在の IVssWMFiledesc インターフェイスに記述されているファイルまたはファイルセットのファイルバックアップ指定を示す、 VSS_FILE_SPEC_BACKUP_TYPE 値のビットマスク(またはビットごとの OR)を格納する DWORD へのポインターです。

戻り値

このメソッドの有効な戻り値コードは次のとおりです。

値	意味
S_OK	ファイル指定情報を正常に返しました。
E_INVALIDARG	pdwTypeMask 変数が NULL のメモリ領域を指しています。
E_OUTOFMEMORY	呼び出し元のメモリまたはその他のシステムリソースが不足しています。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細についてはイベントログを確認してください。詳細については、 Event and Error Handling Under VSS を参照してください。
VSS_E_UNEXPECTED	予期しないエラーです。エラーコードはエラーログファイルに記録されます。詳細については、 Event and Error Handling Under VSS を参照してください。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値は Windows Server 2008 R2 および Windows 7 までサポートされません。代わりに E_UNEXPECTED が使用されます。

解説(Remarks)

ファイルバックアップ指定は、ライターが IVssCreateWriterMetadata::AddFilesToFileGroup、 IVssCreateWriterMetadata::AddDatabaseFiles、または IVssCreateWriterMetadata::AddDatabaseLogFiles メソッドを使用してコンポーネントにファイル指定を追加するときに指定します。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IVssWMFiledesc "{}"
#usecom global IVssWMFiledesc IID_IVssWMFiledesc "{}"
#comfunc global IVssWMFiledesc_GetPath               3 var
#comfunc global IVssWMFiledesc_GetFilespec           4 var
#comfunc global IVssWMFiledesc_GetRecursive          5 var
#comfunc global IVssWMFiledesc_GetAlternateLocation  6 var
#comfunc global IVssWMFiledesc_GetBackupTypeMask     7 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IVssWMFiledesc "{}"
#usecom global IVssWMFiledesc IID_IVssWMFiledesc "{}"
#comfunc global IVssWMFiledesc_GetPath               3 sptr
#comfunc global IVssWMFiledesc_GetFilespec           4 sptr
#comfunc global IVssWMFiledesc_GetRecursive          5 sptr
#comfunc global IVssWMFiledesc_GetAlternateLocation  6 sptr
#comfunc global IVssWMFiledesc_GetBackupTypeMask     7 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。