SccDirQueryInfo Function
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 function examines a list of fully qualified directories for their current status.
Syntax
SCCRTN SccDirQueryInfo(
LPVOID pContext,
LONG nDirs,
LPCSTR* lpDirNames,
LPLONG lpStatus
);
Parameters
pContext
[in] The source control plug-in context structure.
nDirs
[in] The number of directories selected to be queried.
lpDirNames
[in] An array of fully qualified paths of the directories to be queried.
lpStatus
[in, out] An array structure for the source control plug-in to return the status flags (see Directory Status Code for details).
Return Value
The source control plug-in implementation of this function is expected to return one of the following values:
| Value | Description |
|---|---|
| SCC_OK | The query was successful. |
| SCC_E_OPNOTSUPPORTED | The source code control system does not support this operation. |
| SCC_E_ACCESSFAILURE | There was a problem accessing the source control system, probably due to network or contention issues. A retry is recommended. |
| SCC_E_NONSPECIFICERROR SCC_E_UNKNOWNERROR |
Nonspecific failure. |
Remarks
The function fills the return array with a bitmask of bits from the SCC_DIRSTATUS family (see Directory Status Code), one entry for each directory given. The status array is allocated by the caller.
The IDE uses this function before a directory is renamed to check whether the directory is under source control by querying whether it has a corresponding project. If the directory is not under source control, the IDE can provide the proper warning to the user.
Note
If a source control plug-in chooses to not implement one or more of the status values, unimplemented bits should be set to zero.