SccCheckout 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 SccCheckout Function.

Given a list of fully qualified file names, this function checks them out to the local drive. The comment applies to all files being checked out. The comment argument can be a null string.

SCCRTN SccCheckout (  
   LPVOID    pvContext,  
   HWND      hWnd,  
   LONG      nFiles,  
   LPCSTR*   lpFileNames,  
   LPCSTR    lpComment,  
   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 selected to be checked out.

lpFileNames
[in] Array of fully qualified local path names of files to be checked out.

lpComment
[in] Comment to be applied to each of the selected files being checked out.

fOptions
[in] Command flags (see Bitflags Used by Specific Commands).

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:

Source Control Plug-in API Functions
Bitflags Used by Specific Commands