IVssComponent::GetBackupOptions メソッド (vswriter.h)

GetBackupOptions メソッドは、IVssBackupComponents::SetBackupOptions を使用して、リクエスターによって現在選択されているコンポーネントまたはコンポーネントセットを管理するライターに指定されたバックアップオプションを返します。

ライターまたはリクエスターは、このメソッドを呼び出すことができます。

構文

HRESULT GetBackupOptions(
  [out] BSTR *pbstrBackupOptions
);

[out] pbstrBackupOptions

現在のライターのバックアップオプションを含む文字列を受け取る呼び出し元によって割り当てられた変数のアドレス。

このメソッドの有効なリターンコードを次に示します。

値	意味
S_OK	属性値が正常に返されました。
S_FALSE	このコンポーネントにはバックアップオプションが指定されていません。
E_INVALIDARG	パラメーター値の 1 つが無効です。
E_OUTOFMEMORY	呼び出し元がメモリ不足またはその他のシステムリソースです。
VSS_E_INVALID_XML_DOCUMENT	XML ドキュメントが無効です。詳細については、イベントログを確認してください。詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

バックアップオプションが設定されていない場合は、S_FALSEが返されます。

GetBackupOptions の呼び出しが成功した場合、呼び出し元は SysFreeString 関数を呼び出して pbstrBackupOptions パラメーターで返される文字列を解放します。

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	vswriter.h (Vss.h、VsWriter.h を含む)
Library	VssApi.lib