SetObjectsLabel
Purpose
SetObjectsLabel applies the current label to all objects in objList.
Description
If bPropagate is true, the label will also be applied recursively to all destination objects reachable from the objects, else only the specific objects themselves will receive the label. The label is only applied to the currently published version for each object.
Requirements:
The object ID (internal or globally unique) or the name must be set.
Syntax
HRESULT SetObjectsLabel(
LLOBJECTID_t &objList,
const bool bPropagate = true);
Argument |
In/Out |
Description |
objList |
In |
List of object IDs for the objects to be labeled. |
bPropagate |
In |
Flag indicating if the label should also apply to all objects reachable from the objects. |