The handle-based API is a subset of the main API and does not support Folders, User Queries, or Temporary Queries. The API is implemented through the TrkMain.dll dynamic link library.
Certain settings need to be configured before the API can be used. Since the API is installed on a remote server and all connections through this API share the same underlying account information in the connection to the TeamCoherence Server, the DLL that implements the API must have enough information to create this connection.
In order to enable connections through the API, the following information should be added to a file called TrkMain.ini located in the same directory as the TrkMain.dll file:
| [ServerSide]
|
| Connection Name=<Connection>
|
| User=<Username>
|
| Password=<Password>
|
where the values enclosed in <> marks are replaced with actual valid values.
Even though the API uses this connection information to communicate with the server, all actions are carried out and validated using the Username and Password supplied during the call to TCDSTrkConnect.
In the description of the function we include the Delphi definition of the function which is used to wrap the function that is exported from the DLL. We also include the definition of the function that is actually Exported from the DLL.
Where parameters are described, they are the parameters of the Delphi wrapper function and not that of the exported function. In most cases the parameters are the same (but with different types) for the exported function.
© 1995-2011 Quality Software Components Ltd