qc_remove_target_uri :: QUARC MATLAB Functions

navigation bar

qc_remove_target_uri

Stops a QUARC target from serving on a particular URI.

Syntax

result = qc_remove_target_uri(model, key)      % Remove URI identified by KEY on the target associated with MODEL
result = qc_remove_target_uri(config_set, key) % Remove URI identified by KEY on the target associated with the configuration set
result = qc_remove_target_uri(target_uri, key) % Remove URI identified by KEY on the target specified by the target URI
result = qc_remove_target_uri(key)             % Remove URI identified by KEY on the target associated with the current model

Description

Stops a QUARC target from serving on a particular URI and removes the URI from the target's list of URIs. The removal is persistent so the QUARC Target Manager will not serve on that URI the next time it is restarted.

This is a very dangerous function because if all the URIs for a target are removed there will no longer be any means of connecting to that target!

If model is specified, then the target URI associated with the active configuration set of that model is used to identify the target. If a configuration set is specified then its associated target URI is used. If a target URI is specified then it is used directly to access the target.

If no target URI is specified via a model, configuration set or URI then the target associated with the current model is used.

The key argument is the key associated with the URI to remove on the target. Do not specify the URI itself. The key is associated with a URI when the URI is first added to the target. A list of URIs with their associated keys may be obtained using the qc_get_target_uris function.

Parameters

model

A string indicating the name of the model from which to identify the target eg. 'q_a_lpbk'.

config_set

A Simulink.ConfigSet configuration set from which to identify the target (see getConfigSet).

target_uri

A string containing the URI used for communicating with the QUARC Target Manager on the target.

key

A string indicating the key associated with the URI to remove e.g. 'SHMEM'

Outputs

result

Returns 0 on success and a negative error code on failure. See qc_error and qc_get_error_message for handling error codes. If no result output is assigned it issues an error on failure.

Examples

qc_remove_target_uri('SHMEM'); % Removes the URI associated with the key 'SHMEM'