SccDirQueryInfo 関数
この関数は、現在の状態の完全修飾ディレクトリの一覧を調べます。
構文
SCCRTN SccDirQueryInfo(
LPVOID pContext,
LONG nDirs,
LPCSTR* lpDirNames,
LPLONG lpStatus
);
パラメーター
pContext
[入力] ソース管理プラグインのコンテキスト構造体。
nDirs
[入力] クエリ対象として選択されたディレクトリの数。
lpDirNames
[入力] クエリ対象のディレクトリの完全修飾パスの配列。
lpStatus
[入力、出力] ステータス フラグを返すソース管理プラグインの配列構造体 (詳細については、ディレクトリ状態コードに関するページを参照してください)。
戻り値
この関数のソース管理プラグインの実装では、次のいずれかの値が返されることが予期されています。
Value | 説明 |
---|---|
SCC_OK | クエリに成功しました。 |
SCC_E_OPNOTSUPPORTED | ソース コード管理システムでは、この操作はサポートされていません。 |
SCC_E_ACCESSFAILURE | ソース管理システムへのアクセス中に問題が発生しました。ネットワークまたは競合の問題である可能性があります。 再試行することをお勧めします。 |
SCC_E_NONSPECIFICERROR SCC_E_UNKNOWNERROR |
不特定のエラーです。 |
解説
関数により、返される配列に SCC_DIRSTATUS
ファミリのビットのビットマスク (ディレクトリ状態コードに関するページを参照) が入力されます。これは、所与のディレクトリごとに 1 つのエントリです。 状態配列は、呼び出し元によって割り当てられます。
IDE では、ディレクトリの名前を変更する前に、この関数を使用して、ディレクトリがソース管理下にあるかどうかを、対応するプロジェクトがあるかどうかをクエリすることによって確認します。 ディレクトリがソース管理下にない場合、IDE からユーザーに適切な警告を提供できます。
Note
ソース管理プラグインで 1 つ以上の状態値を実装しないことが選択された場合は、実装されていないビットを 0 に設定する必要があります。