TCVcsCheckOutFilesEx

Displays the CheckOut dialog box before checking out or getting the specified files.

Delphi (TCIntf.pas)

function TCVcsCheckOutFilesEx( FileList: TStrings; CheckOutInfo: PCheckOutInfo; ShowStatus: Boolean = True; ShowProgress: Boolean = True ): Integer;

Parameters

Name	Description
FileList	List of files to check in
CheckOutInfo	A pointer to a structure that contains checkout information.
ShowStatus	If True, the Status dialog box will be displayed after all files have been checked out.
ShowProgress	If True, a progress window is displayed.

Return Value

Err_OK if successful or an error code indicating the error.

Remarks

The pointer PCheckOutInfo points to a structure that contains checkout information, including comments and whether to lock the archive or not. There is a utility function, InitializeCheckInInfo, that will initialize the memory required for this pointer and a function, ReleaseCheckInInfo , that releases the memory.

After the files are checked out, and if ShowStatus is True, the Status dialog box will show the success or failure of each action. You then have the ability to retry the failed actions.

Exported

function TCVcsCheckOutFilesEx( FileList: PChar; CheckOutInfo: PCheckOutInfo; ShowStatus, ShowProgress: Boolean ): Integer; stdcall;