SccOpenProject 関数

この関数では、既存のソース管理プロジェクトを開くか、または新しいソース管理プロジェクトを作成します。

構文

SCCRTN SccOpenProject (
   LPVOID        pvContext,
   HWND          hWnd,
   LPSTR         lpUser,
   LPCSTR        lpProjName,
   LPCSTR        lpLocalProjPath,
   LPSTR         lpAuxProjPath,
   LPCSTR        lpComment,
   LPTEXTOUTPROC lpTextOutProc,
   LONG          dwFlags
);

パラメーター

pvContext

[入力] ソース管理プラグインのコンテキスト構造体。

hWnd

[入力] ソース管理プラグインが、提供するすべてのダイアログ ボックスの親として使用できる IDE ウィンドウへのハンドル。

lpUser

[入力、出力] ユーザーの名前 (NULL 終端文字を含め、SCC_USER_SIZE 文字以下)。

lpProjName

[入力] プロジェクトの名前を識別する文字列。

lpLocalProjPath

[入力] プロジェクトの作業フォルダーのパス。

lpAuxProjPath

[入力、出力] プロジェクトを識別する省略可能な補助文字列 (NULL 終端文字を含め、SCC_AUXPATH_SIZE 文字以下)。

lpComment

[入力] 作成されている新しいプロジェクトへのコメント。

lpTextOutProc

[入力] ソース管理プラグインからのテキスト出力を表示するための省略可能なコールバック関数。

dwFlags

[入力] プロジェクトがソース管理プラグインで認識されていない場合、新しいプロジェクトを作成する必要があるかどうかを通知します。 値は SCC_OP_CREATEIFNEW と SCC_OP_SILENTOPEN. の組み合わせにすることができます。

戻り値

この関数のソース管理プラグインの実装では、次のいずれかの値が返されることが予期されています。

解説

IDE ではユーザー名 (lpUser) を渡すか、または単純に空の文字列へのポインターを渡すことができます。 ユーザー名が存在する場合、ソース管理プラグインでは、それを既定値として使用する必要があります。 ただし、名前が渡されなかった場合、または指定された名前でログインに失敗した場合、プラグインではユーザーにログインを入力するよう求める必要があり、有効なログインを受け取ったら lpUser で有効な名前を返します。プラグインがユーザー名文字列を変更する可能性があるため、IDE では、常にサイズ (SCC_USER_LEN+1 または SCC_USER_SIZE、これには NULL 終端文字用の領域が含まれます) のバッファーを割り当てます。

lpAuxProjPathlpProjNameはソリューション ファイルから読み取られます。または、SccGetProjPath関数の呼び出しから返されます。 これらのパラメーターには、ソース管理プラグインによってプロジェクトに関連付けられ、そのプラグインに対してのみ意味がある文字列が含まれています。 このような文字列がソリューション ファイル内に存在せず、ユーザーが参照する (これにより、SccGetProjPath 関数を通して文字列が返されます) よう求められていない場合、IDE では、lpAuxProjPath と lpProjName の両方に対して空の文字列を渡し、この関数から戻ったときにこれらの値がプラグインによって更新されることを期待します。

lpTextOutProc は、コマンド結果の出力を表示する目的で IDE からソース管理プラグインに提供されるコールバック関数へのポインターです。 このコールバック関数は、「LPTEXTOUTPROC」で詳細に説明されています。

dwFlags パラメーターでは、開かれるプロジェクトが現在存在しない場合の結果を制御します。 これは、2 つのビットフラグ SCC_OP_CREATEIFNEW と SCC_OP_SILENTOPEN で構成されます。 開かれるプロジェクトが既に存在する場合、この関数は単純にプロジェクトを開き、SCC_OK を返します。 そのプロジェクトが存在せず、かつ SCC_OP_CREATEIFNEW フラグがオンである場合、ソース管理プラグインではソース管理システム内にプロジェクトを作成し、それを開いてから SCC_OK を返すことができます。 そのプロジェクトが存在せず、かつ SCC_OP_CREATEIFNEW フラグがオフである場合、プラグインでは次に SCC_OP_SILENTOPEN フラグを確認する必要があります。 そのフラグがオンでない場合、プラグインでは、ユーザーにプロジェクト名を入力するよう求めることができます。 そのフラグがオンである場合、プラグインでは単純に SCC_E_UNKNOWNPROJECT を返す必要があります。

呼び出し順序

イベントの通常の過程では、ソース管理セッションを開くために SccInitialize が最初に呼び出されます。 セッションは、SccOpenProject の呼び出しと、それに続く他のソース管理プラグイン API 関数呼び出しで構成されている場合があり、SccCloseProject の呼び出しで終了します。 このようなセッションは、SccUninitialize が呼び出される前に複数回繰り返される可能性があります。

ソース管理プラグインが SccInitialize で SCC_CAP_REENTRANT ビットを設定した場合は、上記のセッション シーケンスが並列に何回も繰り返される可能性があります。 さまざまな pvContext 構造体によって、異なるセッションが追跡されます。ここで、各 pvContext は、一度には 1 つの開いているプロジェクトに関連付けられています。 プラグインは、 pvContext パラメーターに基づいて、特定の呼び出しで参照されるプロジェクトを決定できます。 機能ビット SCC_CAP_REENTRANT が設定されていない場合、再入不可能なソース管理プラグインは、複数のプロジェクトを操作する機能が制限されます。

関連項目

• ソース管理プラグインの API 関数
• SccCloseProject
• SccGetProjPath
• SccInitialize
• SccUninitialize
• 文字列長の制限
• LPTEXTOUTPROC