TCDVcsEnumConnections
Return to Introduction  Previous page  Next page
Enumerates through the list of known repository connections and calls the passed function.

Delphi (TCDirectIntf.pas)

type  
  TEnumConnections = function ( Data: Pointer; Name, Description, Host: String; Port: Integer; Current: Boolean ): Boolean;  
 
function VcsEnumConnections( EnumProc: TEnumConnections; Data: Pointer ): Integer;  

Parameters

Name
Description
EnumProc
The procedure (prototype TEnumConnections) that will be called for each connection located.
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

TEnumConnections is the prototype of the procedure that is called by VcsEnumConnections. This function should return True to continue enumerating the connections, or False to terminate the enumeration. The Enumeration procedure receives the following parameters, describing each connection:

Name
Description
Data
The Data parameter as passed into the enumerator. Can be nil
Name
Connection Name
Description
Description for the connection
Host
The host that the repository resides on. Can either be an IP address or a domain
Port
The Port number being used by the server.
Current
True if the connection described is currently active.


Exported

type  
  TIntEnumConnections = function ( Context, Data: Pointer; pName, pDescription, pHost: PChar; Port: Integer; Current: Boolean ): Boolean; stdcall;  
 
function TCDVcsEnumConnections( Context, Data: Pointer; EnumProc: TIntEnumConnections ): Integer; stdcall;  
 

 


© 1995-2018 MCN Software