SccGetEvents 函式

  • 發行項

此函式會擷取佇列狀態事件。

語法

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

參數

pvContext

[in]原始檔控制外掛程式內容結構。

lpFileName

[in， out]原始檔控制外掛程式放置傳回檔名的緩衝區（最多_MAX_PATH個字元）。

lpStatus

[in， out]傳回狀態代碼（如需可能的值，請參閱 檔案狀態代碼 ）。

pnEventsRemaining

[in， out]傳回此呼叫之後佇列中留下的項目數。 如果這個數位很大，呼叫端可能會決定呼叫 SccQueryInfo 以一次取得所有資訊。

傳回值

此函式的原始檔控制外掛程式實作應該會傳回下列其中一個值：

值 Description
SCC_OK 取得成功事件。
SCC_E_OPNOTSUPPORTED 不支援此函數。
SCC_E_NONSPECIFICERROR 非特定失敗。

備註

此函式會在閑置處理期間呼叫，以查看原始檔控制下是否有任何狀態更新。 原始檔控制外掛程式會維護其知道的所有檔案狀態，而且每當外掛程式注意到狀態變更時，狀態和相關聯的檔案都會儲存在佇列中。 呼叫 時 SccGetEvents ，會擷取並傳回佇列的頂端元素。 此函式受限於只傳回先前快取的資訊，而且必須有非常快速的轉機（也就是說，不讀取磁碟或要求原始檔控制系統的狀態）：否則 IDE 的效能可能會開始降級。

如果沒有要報告的狀態更新，原始檔控制外掛程式會在所 lpFileName指向的緩衝區中儲存空字串。 否則，外掛程式會儲存狀態資訊已變更之檔案的完整路徑名稱，並傳回適當的狀態代碼（檔案狀態代碼中詳述的值之一）。

另請參閱