IVssComponent クラス (vswriter.h)
IVssComponent インターフェイスは、要求者のバックアップ コンポーネント ドキュメントに含まれるコンポーネントに関する情報を調べて変更するためのメソッドを含む C++ (COM ではない) インターフェイスです。
IVssComponent オブジェクトは、 IVssBackupComponents::AddComponent メソッドによるバックアップ操作中にバックアップ コンポーネント ドキュメントに明示的に追加されたコンポーネントに対してのみ取得できます。
IVssBackupComponents::AddRestoreSubcomponent を使用して復元操作中に明示的に追加されたコンポーネントに関する情報は、IVssComponent インターフェイスでは使用できません。
IVssComponent オブジェクトで使用できるコンポーネントと暗黙的に選択されたサブコンポーネントの両方に共通する情報には、次のものが含まれます。
- バックアップのタイムスタンプ
- 復元前/復元後のエラー メッセージ
- メタデータの復元
- 復元対象
- 別の場所マッピング
- 部分ファイル
- 対象ターゲット
インターフェイスはライターまたはリクエスターで使用できますが、特定のメソッドはライターでのみサポートされます。 これにより、ライターは、新しいターゲットの追加などのバックアップまたは復元操作の変更を要求したり、別の場所の使用などの要求者アクションを学習したりできます。
次のメソッドは、 IVssComponent インターフェイスを 返します。
継承
IVssComponent インターフェイスは、IUnknown インターフェイスから継承されます。 IVssComponent には、次の種類のメンバーもあります。
メソッド
IVssComponent クラスには、次のメソッドがあります。
| IVssComponent::AddDifferencedFilesByLastModifyLSN サポートされていません。 (IVssComponent.AddDifferencedFilesByLastModifyLSN) |
| IVssComponent::AddDifferencedFilesByLastModifyTime ライターが、ファイル全体を使用してタイムスタンプ付きの増分バックアップまたは差分バックアップに含めるために、ファイル セット (指定したファイルまたはファイル) を最終変更タイム スタンプに対して評価する必要があることを示すために使用されます。 |
| IVssComponent::AddDirectedTarget AddDirectedTarget メソッドを使用すると、ライターは、復元時にファイル (ソース ファイル) を再マップする必要があることを示すことができます。 |
| IVssComponent::AddPartialFile AddPartialFile メソッドは、特定のファイルの一部のみをバックアップし、それらの部分をバックアップすることを示します。 |
| IVssComponent::GetAdditionalRestores GetAdditionalRestores メソッドは、増分または差分の復元操作中にライターによって使用され、特定のコンポーネントが完全に取得するために追加の復元操作を必要とするかどうかを判断します。 |
| IVssComponent::GetAlternateLocationMapping GetAlternateLocationMapping は、ファイルの復元用にファイル セットの別の場所を返すために使用されます。 このメソッドは、ライターまたはリクエスターによって呼び出すことができます。 |
| IVssComponent::GetAlternateLocationMappingCount GetAlternateLocationMappingCount メソッドは、要求元がデータの復元に使用する代替の場所マッピングの数を返します。 ライターまたは要求者は、このメソッドを呼び出すことができます。 |
| IVssComponent::GetBackupMetadata GetBackupMetadata メソッドは、IVssComponent::SetBackupMetadata を使用して、CVssWriter::OnPrepareBackup によって PrepareForBackup イベント中に設定された可能性がある、ライター固有のプライベート バックアップ メタデータを取得します。 |
| IVssComponent::GetBackupOptions GetBackupOptions メソッドは、IVssBackupComponents::SetBackupOptions を使用して要求元によって現在選択されているコンポーネントまたはコンポーネント セットを管理するライターに指定されたバックアップ オプションを返します。 |
| IVssComponent::GetBackupStamp GetBackupStamp メソッドは、特定のコンポーネントのライターによって格納されたバックアップ スタンプ文字列を返します。 |
| IVssComponent::GetBackupSucceeded GetBackupSucceeded メソッドは、選択したコンポーネントまたはコンポーネント セットのすべてのファイルをVSS_FILE_RESTORE_STATUS列挙体としてバックアップしようとした場合の完全な試行の状態を返します。 |
| IVssComponent::GetComponentName GetComponentName メソッドは、このコンポーネントの論理名を返します。 |
| IVssComponent::GetComponentType GetComponentType メソッドは、VSS_COMPONENT_TYPE列挙体の観点からこのコンポーネントの型を返します。 |
| IVssComponent::GetDifferencedFile GetDifferencedFile メソッドは、増分バックアップまたは差分バックアップまたは差分バックアップまたは復元に参加するファイル セット (指定されたファイル) に関する情報を返します。つまり、ファイルに関連付けられているバックアップと復元は、(部分ファイルを使用するのではなく) バックアップ メディアとの間でファイル全体がコピーされるかのように実装されます。 |
| IVssComponent::GetDifferencedFilesCount 増分バックアップまたは復元をサポートするライターによって異なるファイルとしてマークされた、このコンポーネント (および定義されているコンポーネント セットのサブコンポーネント) 内のファイル仕様の数を返します。 |
| IVssComponent::GetDirectedTarget GetDirectedTarget メソッドは、ライターがバックアップ時に保存した情報をバックアップ コンポーネント ドキュメントに返して、ファイルを復元するときに、ファイル (ソース ファイル) を再マップする必要があることを示します。 |
| IVssComponent::GetDirectedTargetCount GetDirectedTargetCount メソッドは、現在のコンポーネントに関連付けられている対象指定の数を返します。 ライターまたは要求者は、このメソッドを呼び出すことができます。 |
| IVssComponent::GetFileRestoreStatus GetFileRestoreStatus メソッドは、選択したコンポーネントまたはコンポーネント セットのすべてのファイルをVSS_FILE_RESTORE_STATUS列挙体として復元しようとした完了した試行の状態を返します。 |
| IVssComponent::GetLogicalPath GetLogicalPath メソッドは、このコンポーネントの論理パスを返します。 |
| IVssComponent::GetNewTarget GetNewTarget メソッドは、選択したコンポーネントまたはコンポーネント セットの新しいファイル復元の場所を返します。 |
| IVssComponent::GetNewTargetCount GetNewTargetCount メソッドは、特定のコンポーネントに関連付けられている新しいターゲット復元場所の数を返します。 |
| IVssComponent::GetPartialFile GetPartialFile メソッドは、このコンポーネントに関連付けられている部分ファイルに関する情報を返します。 |
| IVssComponent::GetPartialFileCount GetPartialFileCount メソッドは、コンポーネントに関連付けられている部分ファイルの数を返します。 |
| IVssComponent::GetPostRestoreFailureMsg GetPostRestoreFailureMsg メソッドは、IVssComponent::SetPostRestoreFailureMsg が 1 つを設定した場合、PostRestore イベントの処理中にライターによって生成されたエラー メッセージを返します。 |
| IVssComponent::GetPreRestoreFailureMsg GetPreRestoreFailureMsg メソッドは、IVssComponent::SetPreRestoreFailureMsg が設定されている場合、PreRestore イベントの処理中にライターによって生成されたエラー メッセージを取得します。 |
| IVssComponent::GetPreviousBackupStamp GetPreviousBackupStamp メソッドは、バックアップ コンポーネント ドキュメントの要求元によって読み込まれた以前のバックアップ スタンプを返します。 この値は、ファイルを差分バックアップ操作または増分バックアップ操作に参加させる必要があるかどうかを判断するときに、ライターによって使用されます。 |
| IVssComponent::GetRestoreMetadata GetRestoreMetadata メソッドは、IVssComponent::SetRestoreMetadata を使用して、CVssWriter::OnPreRestore によって PreRestore イベント中に設定された可能性がある、ライター固有のプライベートな復元メタデータを取得します。 |
| IVssComponent::GetRestoreOptions GetRestoreOptions メソッドは、IVssBackupComponents::SetRestoreOptions を使用して、リクエスターによって現在のライターに指定された復元オプションを取得します。 |
| IVssComponent::GetRestoreSubcomponent GetRestoreSubcomponent メソッドは、指定されたコンポーネントに関連付けられている指定されたサブコンポーネントを返します。 |
| IVssComponent::GetRestoreSubcomponentCount GetRestoreSubcomponentCount メソッドは、コンポーネントに関連付けられているサブコンポーネントの数を返します。 |
| IVssComponent::GetRestoreTarget GetRestoreTarget メソッドは、現在のコンポーネントの復元ターゲット (VSS_RESTORE_TARGET列挙の観点から) を返します。 |
| IVssComponent::IsSelectedForRestore IsSelectedForRestore メソッドは、現在のコンポーネントが復元対象として選択されているかどうかを判断します。 |
| IVssComponent::SetBackupMetadata SetBackupMetadata メソッドは、コンポーネントを使用してバックアップ メタデータを設定します。 |
| IVssComponent::SetBackupStamp SetBackupStamp メソッドは、バックアップがいつ行われたかを示す情報を含む文字列を設定します。 |
| IVssComponent::SetPostRestoreFailureMsg SetPostRestoreFailureMsg メソッドは、PostRestore イベントの処理中のエラーを説明するメッセージを作成するために使用されます。 |
| IVssComponent::SetPreRestoreFailureMsg SetPreRestoreFailureMsg メソッドは、PreRestore イベントの処理中のエラーを説明するメッセージを作成するために使用されます。 |
| IVssComponent::SetRestoreMetadata SetRestoreMetadata メソッドは、現在のコンポーネントのライター固有のメタデータを設定します。 |
| IVssComponent::SetRestoreTarget SetRestoreTarget メソッドは、現在のコンポーネントの復元ターゲット (VSS_RESTORE_TARGET列挙の観点から) を設定します。 |
要件
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | vswriter.h (Vss.h、VsWriter.h を含む) |