Node::RemoveConnector

Defined in: C4Node.h

Removes a node connector.

Prototype

bool RemoveConnector(const char *key);

Parameters

key The key value for the connector. This is a string up to 15 bytes in length, not counting the null terminator.

Description

The RemoveConnector function removes an existing Connector object from a node. The key parameter specifies the unique identifier for the connector that is to be removed. If a connector with this key exists, then it is deleted, and the RemoveConnector function returns true. The no such connector exists, then the RemoveConnector function performs no action and returns false.

If the node's hub has no connectors remaining after the connector specified by the key parameter is deleted, then the hub is also deleted.