TCDVcsEnumViews
Return to Introduction  Previous page  Next page
Enumerates through the defined Views in the repository.

Delphi (TCDirectIntf.pas)

type  
  TEnumViews = function ( Data: Pointer; Name, Description: String; ID: Cardinal; Shared, Current: Boolean ): Boolean;  
 
function VcsEnumViews( EnumProc: TEnumViews; Data: Pointer ): Integer;  

Parameters

Name
Description
EnumProc
The procedure (prototype TEnumViews) that will be called for each view found.
Data
Pointer to additional information that can be passed to the EnumProc in the Data parameter.


Return Value

Err_OK if successful or an error code indicating the error.

Remarks

TEnumViews is the prototype of the procedure that is called by VcsEnumViews. This function should return True to continue enumerating the labels, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each Label:

Name
Description
Data
The Data parameter as passed into the enumerator. Can be nil
Name
Name of the View
Description
Description of the View
ID
Unique ID used to identify the view
Shared
If True, indicates a View that is shared amongst all users.
Current
If True, indicates that this is the currently selected View


The view returned with the ID of Zero is the default view. This view includes all revisions in all files.

Exported

type  
  TIntEnumViews = function ( Context, Data: Pointer; pName, pDescription: PChar; ID: Cardinal; Shared, Current: Boolean ): Boolean; stdcall;  
 
function TCDVcsEnumViews( Context, Data: Pointer; EnumProc: TIntEnumViews ): Integer; stdcall;  



 


© 1995-2018 MCN Software