TCDVcsCheckOutFileEx
Return to Introduction  Previous page  Next page
Get or Check out a file. This is an extension of the basic TCDVcsCheckOutFile function and is intended to allow a Get or CheckOut of a file to be carried out to a different FileName as well as to another path.

Delphi (TCDirectIntf.pas)

function VcsCheckOutFileEx( FileID: Cardinal; var RevisionID: Cardinal; CheckOutInfo: PCheckOutInfo; FileName: String ): Integer;  

Parameters

Name
Description
FileID
The ID of the file to get/checkout.
RevisionID (Out)
Returns the ID of the revision that was retrieved.
CheckOutInfo
A pointer to a structure that contains checkout information.
FileName
Use this field to specify a different FileName (not including the path) for the Get/Checkout action


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.

Exported

function TCDVcsCheckOutFileEx( FileID: Cardinal; var RevisionID: Cardinal; CheckOutInfo: PCheckOutInfo; pFileName: PChar ): Integer; stdcall;  


 


© 1995-2018 MCN Software