tcom
Description
Allows you to create and edit a comment stream that is assigned to an entity. You can use comments to describe how a tag works or what it is for. Comments can also store variable values which can then be read automatically by an PTC ALD script with tfread.
Example 259. Attach a comment stream to a text stream
The example below attaches the comment stream cm1 to the text stream tx1:
tcom "tx1", "cm1"
Syntax
tcom ( mode:n entity:n? )? tag name:t? comment name:t?
tcom
|
[no parameter]
|
Invoke the Create/Edit comment stream for an entity dialog box
|
|
mode
|
|
0
|
Invoke the Create/Edit comment stream for an entity dialog box
|
|
1
|
Edit the existing comment stream assigned to the entity. Do nothing if one does not exist.
|
|
2
|
Edit the existing comment stream assigned to the entity. Create and edit a new comment if one does not exist.
|
|
|
entity
|
|
1
|
Apply comment to text in the selected frame.
|
|
2
|
Apply comment to object graphic in the selected frame.
|
|
3
|
Apply comment to raster graphic in the selected frame.
|
|
|
If neither an entity nor a tag name is specified a context-sensitive default will be chosen.
|
|
|
tag name
|
The name of the entity to which to apply the comment: this parameter can only be present if the entity parameter is not present.
|
|
If neither an entity nor a tag name is specified a context-sensitive default will be chosen.
|
|
|
comment name
|
The name of the comment stream
|
Related Links
