ITcSysManager::UnlinkVariables
The UnlinkVariables() method unlinks two variables, which are specified by their names, or clears all links from the first variable if the name bstrV2 of the second variable is empty. The two variables represented by their tree path name will be unlinked. The path names must have the same syntax as described in ITcSysManager::LookupTreeItem. The same shortcuts can be used.
HRESULT UnlinkVariables(BSTRbstrV1, BSTRbstrV2); Parameters
|
bstrV1 |
[in] path name of the first variable. The full path name is required and each branch must be separated by a circumflex accent '^' or a tab. |
|
bstrV2 |
[in, defaultvalue(L"")] path name of the second variable. If set the full path name is required and each branch must be separated by a circumflex accent '^' or a tab. |
Return Values
|
S_OK |
function returns successfully. |
|
S_FALSE |
the two variables have no link between them. |
|
TSM_E_ITEMNOTFOUND (0x98510001) |
one or both of the path name(s) does not qualify an existing tree item. |
|
TSM_E_INVALIDITEMTYPE (0x98510002) |
one or both of the tree item(s) is not a variable. |
|
TSM_E_CORRUPTEDLINK (0x98510005) |
the two variables cannot unlinked. |
Comments
|
If bstrV2 is an empty string the function clears all links of variable given by bstrV1. If bstrV2 is not empty only an existing link between both variables will be deleted. |