この関数は、ソース管理システムからファイルを削除します。
構文
SCCRTN SccRemove(
LPVOID pvContext,
HWND hWnd,
LONG nFiles,
LPCSTR* lpFileNames,
LPCSTR lpComment,
LONG fOptions,
LPCMDOPTS pvOptions
);
パラメーター
pvContext
[入力] ソース管理プラグインのコンテキスト構造体。
hWnd
[入力] ソース管理プラグインが、提供するすべてのダイアログ ボックスの親として使用できる IDE ウィンドウへのハンドル。
nFiles
[入力] lpFileNames
配列で指定されているファイルの数。
lpFileNames
[入力] 削除するファイルの完全修飾ローカル パス名の配列。
lpComment
[入力] 削除する各ファイルに適用されるコメント。
fOptions
[入力] コマンド フラグ (未使用)。
pvOptions
[入力] ソース管理プラグイン固有のオプション。
戻り値
この関数のソース管理プラグインの実装では、次のいずれかの値が返されることが予期されています。
Value | 説明 |
---|---|
SCC_OK | 削除に成功しました。 |
SCC_E_FILENOTCONTROLLED | 選択したファイルはソース コード管理されていません。 |
SCC_E_OPNOTSUPPORTED | ソース管理システムでは、この操作をサポートしていません。 |
SCC_E_ISCHECKEDOUT | 現在ユーザーがチェックアウトしているため、ファイルを削除できません。 |
SCC_E_ACCESSFAILURE | ソース管理システムへのアクセス中に問題が発生しました。ネットワークまたは競合の問題である可能性があります。 |
SCC_E_NOTAUTHORIZED | ユーザーには、この操作の実行が許可されていません。 |
SCC_E_NONSPECIFICERROR | 不特定のエラーです。ファイルは削除されませんでした。 |
SCC_I_OPERATIONCANCELED | 操作は完了前にキャンセルされました。 |
解説
この関数は、ソース管理システムからファイルを削除しますが、ユーザーのローカル ハード ドライブからは削除しません。