SccSetOption 関数

この関数では、ソース管理プラグインの動作を制御するオプションを設定します。

構文

SCCRTN SccSetOption(
   LPVOID pvContext,
   LONG   nOption,
   LONG   dwVal
);

パラメーター

pvContext

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

nOption

[入力] 設定しているオプション。

dwVal

[入力] オプションの設定。

戻り値

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

解説

IDE では、ソース管理プラグインの動作を制御するためにこの関数を呼び出します。 最初のパラメーター nOption は設定されている値を示し、2 番目の dwVal はその値の処理方法を示します。 プラグインには、pvContext``, に関連付けられたこの情報が格納されるので、IDE では SccInitialize を呼び出した後にこの関数を呼び出す必要があります (ただし、SccOpenProject を呼び出すたびに必ずしも必要になるとは限りません)。

オプションとその値の概要:

SCC_OPT_EVENTQUEUE

nOption が SCC_OPT_EVENTQUEUE の場合、IDE ではバックグラウンド処理を無効 (または再有効化) しています。 たとえば、コンパイル中に IDE では、任意の種類のアイドル状態の処理を停止するようにソース管理プラグインに対して指示する場合があります。 コンパイル後、プラグインのイベント キューを最新の状態に保つために、バックグラウンド処理を再び有効にします。 nOption の SCC_OPT_EVENTQUEUE 値に対応する 2 つの値 (つまり、SCC_OPT_EQ_ENABLE と SCC_OPT_EQ_DISABLE) を dwVal に使用できます。

SCC_OPT_HASCANCELMODE

nOption の値が SCC_OPT_HASCANCELMODE の場合、IDE ではユーザーが長い操作をキャンセルすることができます。 dwVal を SCC_OPT_HCM_NO (既定値) に設定すると、IDE にキャンセル モードがないことを示します。 ユーザーがキャンセルできるようにする場合は、ソース管理プラグインに独自の [キャンセル] ボタンが用意されている必要があります。 SCC_OPT_HCM_YES は、IDE で操作をキャンセルする機能が用意されていることを示します。そのため、SCC プラグインでは、独自の [キャンセル] ボタンが表示されている必要はありません。 IDE で dwVal が SCC_OPT_HCM_YES に設定されている場合、lpTextOutProc コールバック関数に送信された SCC_MSG_STATUS および DOCANCEL メッセージに応答する準備ができています (「LPTEXTOUTPROC」を参照してください)。 IDE でこの変数が設定されていない場合、プラグインではこれら 2 つのメッセージを送信できません。

SCC_OPT_NAMECHANGEPFN

NOption が SCC_OPT_NAMECHANGEPFN に設定されていて、ソース管理プラグインと IDE の両方でこれを許可している場合、プラグインでは実際にソース管理操作中にファイルの名前変更や移動を行うことができます。 dwVal は、OPTNAMECHANGEPFN 型の関数ポインターに設定されます。 ソース管理操作中に、プラグインではこの関数を呼び出して、3 つのパラメーターを渡すことができます。 これらは、ファイルの (完全修飾パスを持つ) 前の名前、そのファイルの (完全修飾パスを持つ) 新しい名前、IDE に関連する情報へのポインターです。 IDE では、nOption を SCC_OPT_USERDATA に設定して dwVal がデータを指すようにして SccSetOption を呼び出すことで、この最後のポインターを送信します。 この関数のサポートは省略可能です。 この機能を使用する VSSCI プラグでは、関数ポインターとユーザー データ変数を NULL に初期化する必要があります。また指定されていない場合は、rename 関数を呼び出すことはできません。 また、指定された値を保持するか、SccSetOption への新しい呼び出しに応じてこれを変更する準備ができている必要があります。 これは、ソース管理コマンド操作の途中では発生しませんが、コマンド間で発生する可能性があります。

SCC_OPT_SCCCHECKOUTONLY

nOption が SCC_OPT_SCCCHECKOUTONLY に設定されている場合、IDE では、ソース管理システムのユーザー インターフェイスを介して、現在開いているプロジェクト内のファイルを手動でチェックアウトしてはならないことを示しています。 代わりに、ファイルをチェックアウトする場合は、IDE コントロールのソース管理プラグインのみを使用する必要があります。 dwValue が SCC_OPT_SCO_NO に設定されている場合は、ファイルがプラグインによって正常に処理され、ソース管理 UI でチェックアウトできることを意味します。 dwValue が SCC_OPT_SCO_YES に設定されている場合は、プラグインのみがファイルのチェックアウトを許可され、ソース管理システムの UI を呼び出すことはできません。 これは、IDE に "擬似ファイル" が含まれている可能性がある状況のためです。この場合、IDE でのみチェックアウトするのが理にかなっています。

SCC_OPT_SHARESUBPROJ

nOptionが SCC_OPT_SHARESUBPROJ に設定されている場合、IDE は、ソース管理からファイルを追加するときに、ソース管理プラグインが指定されたローカル フォルダーを使用できるかどうかをテストします。 この場合、dwVal パラメーターの値は問題になりません。 SccAddFromScc が呼び出されたときにソース管理からファイルが追加されるローカルの送信先フォルダーを IDE で指定することがプラグインによって許可されている場合、プラグインでは SccSetOption 関数が呼び出されたときに SCC_I_SHARESUBPROJOK を返す必要があります。 次に、IDE では SccAddFromScc 関数の lplpFileNames パラメーターを使用して、送信先フォルダーを渡します。 プラグインでは、この送信先フォルダーを使用して、ソース管理から追加されたファイルを配置します。 SCC_OPT_SHARESUBPROJ オプションを設定したときにプラグインで SCC_I_SHARESUBPROJOK が返されない場合、プラグインでは現在のローカル フォルダーにのみファイルを追加できることが、IDE で前提とされています。

関連項目

• ソース管理プラグインの API 関数
• SccInitialize
• SccOpenProject
• SccAddFromScc
• LPTEXTOUTPROC
• OPTNAMECHANGEPFN