POPLISTFUNC
這個回呼是由 IDE 提供給 SccPopulateList ,並由原始檔控制外掛程式用來更新檔案或目錄清單(也提供給 SccPopulateList
函式)。
當使用者在 IDE 中選擇 [取得] 命令時,IDE 會顯示使用者可取得之所有檔案的清單框。 不幸的是,IDE 並不知道使用者可能取得之所有檔案的確切清單;只有外掛程式具有此清單。 如果其他使用者已將檔案新增至原始程式碼控制項專案,這些檔案應該會出現在清單中,但 IDE 並不知道這些檔案。 IDE 會建置其認為用戶可以取得的檔案清單。 在向使用者顯示此清單之前,它會呼叫 SccPopulateList,
,讓原始檔控制外掛程式有機會從清單中新增和刪除檔案。
簽章
原始檔控制外掛程式會呼叫具有下列原型的 IDE 實作函式來修改清單:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
參數
pvCallerData pvCallerData
呼叫端傳遞至 SccPopulateList 的參數。 原始檔控制外掛程式應該不會假設此參數的內容。
fAddRemove If TRUE
lpFileName
是應該新增至檔案清單的檔案。 如果 FALSE
為 , lpFileName
則為應該從檔案清單中刪除的檔案。
nStatus 狀態 為 lpFileName
(位的組合 SCC_STATUS
;如需詳細資訊,請參閱 檔案狀態代碼 )。
要從清單中新增或刪除之檔名的 lpFileName 完整目錄路徑。
傳回值
值 | Description |
---|---|
TRUE |
外掛程式可以繼續呼叫此函式。 |
FALSE |
IDE 端發生問題(例如記憶體不足的情況)。 外掛程式應該會停止作業。 |
備註
針對原始檔控制外掛程式想要從檔案清單中新增或刪除的每個檔案,它會呼叫此函式,並 lpFileName
傳入 。 旗 fAddRemove
標會指出要新增至清單的新檔案或要刪除的舊檔案。 參數 nStatus
會提供檔案的狀態。 當 SCC 外掛程式完成新增和刪除檔案時,它會從 SccPopulateList 呼叫傳回。
注意
SCC_CAP_POPULATELIST
Visual Studio 需要功能位。