ソース管理プラグインの API 関数
ソース管理プラグイン API には、次の関数が用意されています。これらの関数は、この API に従って、ソース管理プラグインによって実装される必要があります。 各関数のシグネチャ、およびビット フラグとその他のパラメーターに関連付けられているセマンティクスについては、このリファレンスで詳しく説明します。
初期化関数とハウスキーピング関数
| 関数 | 説明 |
|---|---|
| SccCloseProject | プロジェクトを閉じます。 |
| SccGetCommandOptions | 特定のコマンドの詳細オプションを使用するよう、ユーザーに促します。 |
| SccGetVersion | ソース管理プラグインのバージョンを返します。 |
| SccInitialize | ソース管理プラグインを初期化します。 これは、プラグインのインスタンスごとに 1 回、呼び出されます。 |
| SccOpenProject | プロジェクトを開きます。 |
| SccSetOption | さまざまなオプションを設定するために使用されるジェネリック関数。 各オプションは SCC_OPT_xxx で始まり、独自の定義された一連の値が含まれています。 |
| SccUninitialize | ソース管理プラグインを解除する必要があるときに 1 回、呼び出されます。 |
コア ソース管理関数
| 関数 | 説明 |
|---|---|
| SccAdd | 完全修飾パス名によって指定されたファイルの配列をソース管理システムに追加します。 |
| SccAddFromScc | ソース管理システムに既に存在するファイルをユーザーが参照し、そのファイルを現在のプロジェクトの一部として含めることができるようにします。 |
| SccCheckin | ファイルの配列をチェックインします。 |
| SccCheckout | ファイルの配列をチェックアウトします。 |
| SccDiff | 完全修飾パス名によって指定されたローカル ユーザーのファイルと、ソース管理下のバージョンとの違いを表示します。 |
| SccGet | 一連のファイルの読み取り専用コピーを取得します。 |
| SccGetEvents | 呼び出し元が (SccQueryInfo を使用して) 問い合わせたファイルの状態を確認します。 |
| SccGetProjPath | プラグインにとって意味のあるプロジェクト パスを指定することをソース管理プラグインがユーザーに促すようにします。 |
| SccHistory | 完全修飾ローカル ファイル名の配列の履歴を表示します。 |
| SccPopulateList | ファイルの一覧で、ファイルの現在の状態を調べます。 さらに、ファイルが nCommand の条件に一致しない場合は、pfnPopulate 関数を使用して呼び出し元に通知します。 |
| SccProperties | 完全修飾ファイルのプロパティを表示します。 |
| SccQueryInfo | 完全修飾ファイルの一覧で、ファイルの現在の状態を調べます。 |
| SccRemove | 完全修飾ファイルの配列をソース管理システムから削除します。 |
| SccRename | 特定のファイルの名前を、ソース管理システムでの新しい名前に変更します。 |
| SccRunScc | ソース管理システムのすべての機能にアクセスします。 |
| SccUncheckout | ファイルの配列のチェックアウトを元に戻します。 |
追加機能をサポートする関数 (ソース管理プラグイン API のバージョン 1.2)
この関数のグループは、ソース管理プラグイン API のバージョン 1.2 に含まれる追加機能を定義します。 これらの関数は、より高度なソース管理機能へのアクセスを提供します。
| 関数 | 説明 |
|---|---|
| SccBeginBatch | バッチ操作を開始します。 |
| SccCreateSubProject | 既存の親プロジェクトの下に、特定の名前のサブプロジェクトを作成します。 |
| SccDirDiff | 完全修飾パス名によって指定されたローカル ユーザーのディレクトリと、ソース管理データベースの場所との違いを表示します。 |
| SccDirQueryInfo | 完全修飾ディレクトリの一覧で、ディレクトリの現在の状態を調べます。 |
| SccEndBatch | バッチ操作を終了します。 |
| SccGetParentProjectPath | 特定のプロジェクト (プロジェクトが存在している必要があります) の親パスを返します。 |
| SccIsMultiCheckoutEnabled | ファイルに対して複数のチェックアウトが許可されるかどうかを確認します。 |
| SccWillCreateSccFile | プラグインが MSSCCPRJ.SCC ファイルを作成するかどうかを確認します。 |
高度な機能をサポートする関数 (ソース管理プラグイン API のバージョン 1.3)
この関数のグループは、ソース管理プラグイン API のバージョン 1.3 に含まれる追加機能を定義します。 これらの関数は、より高度なソース管理機能へのアクセスを提供します。
| 関数 | 説明 |
|---|---|
| SccAddFilesFromSCC | ソース管理から現在のプロジェクトに、ファイルの一覧を追加します。 |
| SccBackgroundGet | ユーザー インターフェイスを使用せずにソース管理からファイルの一覧を取得します。 |
| SccEnumChangedFiles | ローカル ファイルとは異なる、ソース管理内のファイルの一覧を取得します。 |
| SccGetExtendedCapabilities | ソース管理プラグインでサポートされている拡張機能を指定するフラグを取得します。 |
| SccGetUserOption | ユーザー固有のオプションを取得します。 |
| SccPopulateDirList | ソース管理下にある 1 つまたは複数のプロジェクト内のディレクトリとファイルの一覧を調べます。 見つかった各ディレクトリおよびファイル名は、コールバック関数に渡されます。 |
| SccQueryChanges | ファイルの一覧に対して行われた名前の変更を調べます。 各ファイル名は、その変更の状態と共にコールバック関数に渡されます。 |
要件
ヘッダー: scc.h
(環境 SDK の共通インクルード フォルダーで提供されます。これは既定では、[drive]\Program Files\VSIP 8.0\EnvSDK\common\inc です。また、MSSCCI サンプルを含む VSIP フォルダー、[drive]\Program Files\VSIP 8.0\MSSCCI でも提供されます)。