Model.CE_DetailSetStringByMark

Model.CE_DetailSetStringByMark(collection, detail_name, string_value, reserved, force_storage)

Sets a string connector detail for a collection of connectors.

Parameters:

• collection (Collection) – The collection containing the connector entities to update.

• detail_name (hwString) – The name of the standard string detail, or user-defined string detail, to update. See Model.CE_DetailSetString() for valid details.

• string_value (hwString) – The string value to update for the detail.

• reserved (unsigned int) – Reserved for future development. Must be set to 0.

• force_storage (unsigned int) –

  0 - Do not store user-defined detail.

  1 - Store user-defined detail.

Example

Set the user property script for connectors WITH IDs 1, 2, 3, and 4

import hm
import hm.entities as ent

model = hm.Model()

model.CE_DetailSetStringByMark(
    collection=hm.Collection(model, ent.Connector, [1, 2, 3, 4]),
    detail_name="ce_propertyscript",
    string_value="C:/temp/scripts/connectors/test.tcl",
    reserved=0,
    force_storage=0,
)