Method Connect
Connect()
Connects to TopSolid application.
Declaration
public bool Connect()Returns
| Type | Description |
|---|---|
| bool | TopSolid has been automatically started. |
Remarks
TopSolid is automatically started if it is not already running.
When starting TopSolid automatically, if several versions are installed, the most recent version is started.
When starting TopSolid automatically, if both 64-bit and 32-bit versions are installed, the 64-bit version is started.
This methods waits up to 10 minutes for TopSolid to be ready before failing to connect.
Connect(string)
Connects to TopSolid application.
Declaration
public bool Connect(string inClientName)Parameters
| Type | Name | Description |
|---|---|---|
| string | inClientName | Name identifying your application, ex: "MyApplication". |
Returns
| Type | Description |
|---|---|
| bool | TopSolid has been automatically started. |
Remarks
TopSolid is automatically started if it is not already running.
When starting TopSolid automatically, if several versions are installed, the most recent version is started.
When starting TopSolid automatically, if both 64-bit and 32-bit versions are installed, the 64-bit version is started.
This methods waits up to 10 minutes for TopSolid to be ready before failing to connect.
Connect(bool, int)
Connects to TopSolid application.
Declaration
public bool Connect(bool inStarts, int inTimeOut)Parameters
| Type | Name | Description |
|---|---|---|
| bool | inStarts | Automatically starts TopSolid if it is not already running. |
| int | inTimeOut | Number of seconds to wait for TopSolid to be ready before failing to connect. |
Returns
| Type | Description |
|---|---|
| bool | TopSolid has been automatically started. |
Remarks
When starting TopSolid automatically, if several versions are installed, the most recent version is started.
When starting TopSolid automatically, if both 64-bit and 32-bit versions are installed, the 64-bit version is started.
Connect(bool, int, string)
Connects to TopSolid application.
Declaration
public bool Connect(bool inStarts, int inTimeOut, string inClientName)Parameters
| Type | Name | Description |
|---|---|---|
| bool | inStarts | Automatically starts TopSolid if it is not already running. |
| int | inTimeOut | Number of seconds to wait for TopSolid to be ready before failing to connect. |
| string | inClientName | Name identifying your application, ex: "MyApplication". |
Returns
| Type | Description |
|---|---|
| bool | TopSolid has been automatically started. |
Remarks
When starting TopSolid automatically, if several versions are installed, the most recent version is started.
When starting TopSolid automatically, if both 64-bit and 32-bit versions are installed, the 64-bit version is started.
The inClientName string must uniquely identify your application, as it is used to make a Windows pipe name that must be unique
when managing events.