POPDIRLISTFUNC

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

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.

Signature

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

Parameters

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.

Return Value

The IDE returns an appropriate error code:

Value Description
SCC_OK Continue processing.
SCC_I_OPERATIONCANCELED Stop processing.
SCC_E_xxx Any appropriate source control error should stop processing.

Remarks

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.

See Also

Callback Functions Implemented by the IDE
SccPopulateDirList
Error Codes