SccUncheckout
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

SccUncheckout Function

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

This function undoes a previous checkout operation, thereby restoring the contents of the selected file or files to the state prior to the checkout. All changes made to the file since the checkout are lost.


SCCRTN SccUncheckout (
   LPVOID    pvContext,
   HWND      hWnd,
   LONG      nFiles,
   LPCSTR*   lpFileNames,
   LONG      fOptions,
   LPCMDOPTS pvOptions
);

Parameters

pvContext

[in] The source control plug-in context structure.

hWnd

[in] A handle to the IDE window that the source control plug-in can use as a parent for any dialog boxes that it provides.

nFiles

[in] Number of files specified in the lpFileNames array.

lpFileNames

[in] Array of fully qualified local path names of files for which to undo a checkout.

fOptions

[in] Command flags (not used).

pvOptions

[in] Source control plug-in-specific options.

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

Value Description

SCC_OK

Undo checkout was successful.

SCC_E_FILENOTCONTROLLED

The selected file is not under source code control.

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

Nonspecific failure. Undo checkout did not succeed.

SCC_E_NOTCHECKEDOUT

The user does not have the file checked out.

SCC_E_NOTAUTHORIZED

The user is not allowed to perform this operation.

SCC_E_PROJNOTOPEN

The project has not been opened from source control.

SCC_I_OPERATIONCANCELED

The operation was cancelled before completion.

After this operation, the SCC_STATUS_CHECKEDOUT and SCC_STATUS_MODIFIED flags will both be cleared for the files on which the undo checkout was performed.

Show:
© 2016 Microsoft