Control connection between STK and an application using Connect
ConControl <ApplicationPath> {ConControlOption}
ConControl messages affect the state of the connection between STK and Connect or Connect and the user application.
Warning: If you send a command, you usually need to change your Connect interface processing. For example, if Acknowledgment is set to On, the user receives an ACK or NACK for each subsequent command sent. The Connect API functions adjust for control Commands automatically.
Warning: If the ConControl command is issued from a COM interface (HTML page) only the VerboseOn and VerboseOff {ConControlOptions} will process successfully.
{ConControlOption} can be:
| {ConControlOption} | Description |
|---|---|
| {AsyncOn | AsyncOff} | Control whether Connect should place the connection in asynchronous communications mode. This command must be enabled in the Basic properties for the application. |
| {AckOn | AckOff} | Control whether Connect sends an acknowledgment message (ACK) in response to receipt of an incoming message. |
| {ErrorOn | ErrorOff} | Control whether Connect notifies the user of any errors that occur during Connect processing. |
| {VerboseOn | VerboseOff} | Control whether Connect will return detailed information about connections and message traffic to standard output. |
| {WildcardIgnoreNacksOn | WildcardIgnoreNacksOff} | This option effects commands when using
a wildcard character in the <ObjectPath>, see Using WildCards.
WildcardIgnoreNacksOff - if one of the objects causes a Nack the command will immediately exit (this is the default). WildcardIgnoreNacksOn - if one of the objects causes a Nack the command will continue processing the remaining objects. Note: If WildcardIgnoreNacksOn is set then the ack/nack status returned is the result of the command on the last object processed. |
| {HighSpeedOn | HighSpeedOff} | Sets the current Connect connection to high speed, which means that no other STK processing is run except reading the socket and processing the commands on that connection. If you set HighSpeedOff, Connect returns the Connect connection to standard communications mode so that multiple tasks can be run at the same time. |
| Disconnect | Disconnected from STK. |
| QuitSTK [AskForSave] | Terminates the current STK session. If the AskForSave keyword is included in the command, then the Save dialog will be displayed before STK quits. |
Warning: If you set the HighSpeedOn {ConControlOption}, STK can't process other commands until the HighSpeedOff command is sent.
To disable the Error output:
ConControl / ErrorOff
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
9.0
STK Programming Interface 11.0.1