SccGetEvents Function
This function retrieves a queued status event.
SCCRTN SccGetEvents (
LPVOID pvContext,
LPSTR lpFileName,
LPLONG lpStatus,
LPLONG pnEventsRemaining
);
Parameters
pvContext
[in] The source control plug-in context structure.lpFileName
[in, out] Buffer where the source control plug-in puts the returned file name (up to _MAX_PATH characters).lpStatus
[in, out] Returns status code (see File Status Code Enumerator for possible values).pnEventsRemaining
[in, out] Returns number of entries left in the queue after this call. If this number is large, the caller may decide to call the SccQueryInfo Function to get all the information at once.
Return Value
The source control plug-in implementation of this function is expected to return one of the following values:
Value |
Description |
|---|---|
SCC_OK |
Get events succeeded. |
SCC_E_OPNOTSUPPORTED |
This function is not supported. |
SCC_E_NONSPECIFICERROR |
Nonspecific failure. |
Remarks
This function is called during idle processing to see if there have been any status updates for files under source control. The source control plug-in maintains status of all the files it knows about, and whenever a change of status is noted by the plug-in, the status and the associated file are stored in a queue. When SccGetEvents is called, the top element of the queue is retrieved and returned. This function is constrained to return only previously cached information and must have a very quick turnaround (that is, no reading of the disk or asking the source control system for status); otherwise the performance of the IDE may start to degrade.
If there is no status update to report, the source control plug-in stores an empty string in the buffer pointed to by lpFileName. Otherwise, the plug-in stores the full path name of the file for which the status information has changed and returns the appropriate status code (one of the values detailed in File Status Code Enumerator).