SccWillCreateSccFile 関数
この関数では、ソース管理プラグインが、指定された各ファイルに対する MSSCCPRJ.SCC ファイルの作成をサポートしているかどうかを判定します。
構文
SCCRTN SccWillCreateSccFile(
LPVOID pContext,
LONG nFiles,
LPCSTR* lpFileNames,
LPBOOL pbSccFiles
);
パラメーター
pContext
[入力] ソース管理プラグインのコンテキスト ポインター。
nFiles
[入力] lpFileNames
配列に含まれているファイル名の数であると同時に、pbSccFiles
配列の長さでもあります。
lpFileNames
[入力] チェックする完全修飾ファイル名の配列 (配列は呼び出し元で割り当てる必要がある)。
pbSccFiles
[入力、出力] 結果を格納するための配列。
戻り値
この関数のソース管理プラグインの実装では、次のいずれかの値が返されることが予期されています。
Value | 説明 |
---|---|
SCC_OK | 成功しました。 |
SCC_E_INVALIDFILEPATH | 配列内のいずれかのパスが無効です。 |
SCC_E_NONSPECIFICERROR | 不特定のエラーです。 |
解説
この関数は、ソース管理プラグインが、指定された各ファイルに対する MSSCCPRJ.SCC ファイルのサポートを提供しているかどうかを判定するためのファイルの一覧を使用して呼び出されます (MSSCCPRJ.SCC ファイルの詳細については、「MSSCCPRJ.SCC ファイル」を参照)。 ソース管理プラグインでは、初期化中に SCC_CAP_SCCFILE
を宣言することによって、MSSCCPRJ.SCC ファイルを作成する機能があるかどうかを宣言できます。 プラグインでは、指定されたファイルのうちのどれに MSSCCPRJ.SCC のサポートがあるかを示すために、pbSccFiles
配列内のファイルごとに TRUE
または FALSE
を返します。 プラグインがこの関数から成功コードを返した場合は、戻り配列内の値が使用されます。 失敗した場合、この配列は無視されます。