POPDIRLISTFUNC

 

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 POPDIRLISTFUNC.

This is a callback function given to the SccPopulateDirList function to update a collection of directories and (optionally) file names to find out which are under source control.

The POPDIRLISTFUNC callback should be called only for those directories and file names (in the list given to the SccPopulateDirList function) that are actually under source control.

typedef BOOL (*POPDIRLISTFUNC)(  
   LPVOID pvCallerData,  
   BOOL bFolder,  
   LPCSTR lpDirectoryOrFileName  
);  

pvCallerData
[in] User value given to SccPopulateDirList.

bFolder
[in] TRUE if the name in lpDirectoryOrFileName is a directory; otherwise the name is a file name.

lpDirectoryOrFileName
[in] Full local path to a directory or file name that is under source code control.

The IDE returns an appropriate error code:

ValueDescription
SCC_OKContinue processing.
SCC_I_OPERATIONCANCELEDStop processing.
SCC_E_xxxAny appropriate source control error should stop processing.

If the fOptions parameter of the SccPopulateDirList function contains the SCC_PDL_INCLUDEFILES flag, then the list will possibly contain file names as well as directory names.

Callback Functions Implemented by the IDE
SccPopulateDirList
Error Codes

Show: