SccQueryChanges Function

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at SccQueryChanges Function.

This function enumerates a given list of files, providing information about name changes for each file via a callback function.

SCCRTN SccQueryChanges(  
   LPVOID           pContext,  
   LONG             nFiles,  
   LPCSTR*          lpFileNames,  
   QUERYCHANGESFUNC pfnCallback,  
   LPVOID           pvCallerData  
);  

Parameters

pContext
[in] The source control plug-in context pointer.

nFiles
[in] Number of files in lpFileNames array.

lpFileNames
[in] Array of file names to get information about.

pfnCallback
[in] Callback function to call for each file name in the list (see QUERYCHANGESFUNC for details).

pvCallerData
[in] Value that will be passed unchanged to the callback function.

The source control plug-in implementation of this function is expected to return one of the following values:

ValueDescription
SCC_OKThe query process completed successfully.
SCC_E_PROJNOTOPENThe project has not been opened in source control.
SCC_E_ACCESSFAILUREThere was a problem accessing the source control system, probably due to network or contention issues.
SCC_E_NONSPECIFICERRORAn unspecified or general error occurred.

Changes being queried for are to the namespace: specifically, renaming, adding, and removing a file.

Source Control Plug-in API Functions
QUERYCHANGESFUNC
Error Codes

Show: