SccGetEvents 函式
這個函式會擷取佇列的狀態事件。
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
參數
pvContext
[in]原始檔控制外掛程式的內容結構。lpFileName
輸入 [、 輸出]緩衝區中的原始檔控制外掛程式會將傳回的檔名 (最多為 _MAX_PATH 字元為單位)。lpStatus
輸入 [、 輸出]傳回狀態碼 (請參閱檔案狀態碼列舉程式的可能值)。pnEventsRemaining
輸入 [、 輸出]傳回在這個呼叫之後保留在佇列中的項目數目。 如果這個數字很大，可能會決定呼叫端呼叫SccQueryInfo 函式以取得所有資訊一次。
傳回值
原始檔控制外掛程式的實作這個函式被期待傳回下列值之一：
值 |
描述 |
|---|---|
SCC_OK |
取得成功的事件。 |
SCC_E_OPNOTSUPPORTED |
不支援這個功能。 |
SCC_E_NONSPECIFICERROR |
非特定的失敗。 |
備註
閒置的處理，以查看是否有任何更新原始檔控制下檔案的狀態時，會呼叫這個函數。 原始檔控制外掛程式會維護它所知，所有檔案的狀態，只要變更狀態被記下外掛程式，狀態和相關聯的檔案會儲存在佇列中。 當SccGetEvents呼叫時，最上方是擷取佇列中的項目，並將其傳回。 這個函式來傳回唯一先前快取的資訊會受到限制，且必須非常快速的作業 (也就是沒有磁碟的讀取或詢問原始檔控制系統的狀態) ； 否則可能會開始 IDE 的效能降低。
如果沒有狀態更新到報表，會將原始檔控制外掛程式儲存空的字串所指向的緩衝區lpFileName。 否則，外掛程式儲存檔案的完整路徑名稱的它的狀態資訊已變更並傳回適當的狀態碼 (其中一個值的詳細說明檔案狀態碼列舉程式)。