プログラマーズ リファレンス
 
このページをシェアする                  
プログラマーズ リファレンス
Backup Agent API リファレンス
この付録では、Backup Agent に含まれるアプリケーション プログラミング インターフェイス(API)を使用する開発者向けのリファレンス情報を提供します。この付録は、高度な概念や入門的な情報を提供するものではありません。
以下の機能が含まれます。
n PvBackupSetOn()
n PvBackupSetOff()
n PvBackupGetStatus()
n PvBackupGetLogDir()
n PvBackupGetLogDirW()
PvBackupSetOn()
説明
Backup Agent をオンにします。
インクルード
pvbackupapi.h
ライブラリ
pvbackupapi.lib(Windows 32 ビット)
w64pvbackupapi.lib(Windows 64 ビット)
構文
BU_STAT PvBackupSetOn();
戻り値
 
BU_ON
Backup Agent は有効になりました(または、この関数が呼び出されたときに既に有効になっていました)。
BU_ERROR
エラーに より Backup Agent を有効にできませんでした。 PvBackupGetLogDir() を使用して、そのエラー情報を含むログ ファイルを見つけてください。
BU_BUSY
進行中のクリーンアップ操作またはスタートアップ操作によってシステムがビジー状態であるため、Backup Agent を有効にできませんでした。数秒後に再試行してください。
BU_ON_WITHERROR
Backup Agent は有効になっていますが、有効にしてからいくつかのエラーが発生しています。
BU_INSTALL_ERROR
互換性のない MicroKernel、または Backup Agent の不完全なインストールが検出されました。Backup Agent イベント ハンドラーは正しくインストールされず登録されていない可能性があります。Backup Agent ソフトウェアを再インストールしてください。
PvBackupSetOff()
説明
Backup Agent をオフにします。
インクルード
pvbackupapi.h
ライブラリ
pvbackupapi.lib(Windows 32 ビット)
w64pvbackupapi.lib(Windows 64 ビット)
構文
BU_STAT PvBackupSetOff();
戻り値
 
BU_OFF
Backup Agent は無効になりました(または、この関数が呼び出されたときに既に無効になっていました)。
BU_ERROR
エラーにより Backup Agent を無効にできませんでした。PvBackupGetLogDir() を使用して、そのエラー情報を含むログ ファイルを見つけてください。この値は、この関数を呼び出す前にエラーが発生していた場合には返されません。PvBackupGetStatus() を使用して情報を取得してください。
BU_BUSY
進行中のクリーンアップ操作またはスタートアップ操作によってシステムがビジー状態であるため、Backup Agent を無効にできませんでした。数秒後に再試行してください。
BU_INSTALL_ERROR
互換性のない MicroKernel、または Backup Agent の不完全なインストールが検出されました。Backup Agent イベント ハンドラーは正しくインストールされず登録されていない可能性があります。Backup Agent ソフトウェアを再インストールしてください。
PvBackupGetStatus()
説明
Backup Agent の現在の状態を取得します。
インクルード
pvbackupapi.h
ライブラリ
pvbackupapi.lib(Windows 32 ビット)
w64pvbackupapi.lib(Windows 64 ビット)
構文
BU_STAT PvBackupGetStatus();
戻り値
 
BU_ON
Backup Agent は有効になっており、エラーは発生していません。
BU_OFF
Backup Agent は無効になっています。
BU_ERROR
Backup Agent はエラーにより状態を取得できません。PvBackupGetLogDir() を使用して、そのエラー情報を含むログ ファイルを見つけてください。
BU_ON_WITHERROR
Backup Agent は有効になっていますが、有効にしてからいくつかのエラーが発生しています。
BU_BUSY
進行中のクリーンアップ操作またはスタートアップ操作によってシステムがビジー状態であるため、Backup Agent は状態の取得要求を処理できません。数秒後に再試行してください。
BU_INSTALL_ERROR
互換性のない MicroKernel、または Backup Agent の不完全なインストールが検出されました。Backup Agent イベント ハンドラーは正しくインストールされず登録されていない可能性があります。Backup Agent ソフトウェアを再インストールしてください。
PvBackupGetLogDir()
説明
Backup Agent ログ ファイルが書き出されるディレクトリを取得します。
インクルード
pvbackupapi.h
ライブラリ
pvbackupapi.lib(Windows 32 ビット)
w64pvbackupapi.lib(Windows 64 ビット)
構文
const char* const PvBackupGetLogDir();
戻り値
 
char*
システムのデフォルトの文字エンコードによる ANSI 文字列を含む静的バッファーへのポインターです。失敗した場合や、LogsPath レジストリ キーが削除されているか空の場合は NULL を返します。
この文字列は、英語のみを使用するシステムでは ASCII として使用できます。
備考
これはシングル バイト文字セットです。
関連項目
PvBackupGetLogDirW()
PvBackupGetLogDirW()
説明
Backup Agent ログ ファイルが書き出されるディレクトリを取得します。
インクルード
pvbackupapi.h
ライブラリ
pvbackupapi.lib(Windows 32 ビット)
w64pvbackupapi.lib(Windows 64 ビット)
構文
const wchar_t* const PvBackupGetLogDirW();
戻り値
 
wchar_t*
ワイド文字列を含む静的文字列へのポインターです。失敗した場合や、LogsPath レジストリ キーが削除されているか空の場合は NULL を返します。
備考
これはダブル バイト文字セットです。
関連項目
PvBackupGetLogDir()