PurgeLayer

Removes an existing layer from the document.  Unlike the DeleteLayer method, PurgeLayer will remove the layer even if contains geometry objects.  The layer to be removed cannot be the current layer.  

Syntax

rhinoscript.layer.PurgeLayer (layer)

rhinoscriptsyntax.PurgeLayer (layer)

Parameters

layer

Required.  String.  The name of the layer to purge.

Returns

String

The name of the purged layer if successful.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

layer = rs.GetString("Layer to purge")

if layer: rs.PurgeLayer(layer)

Also See

AddLayer

CurrentLayer

DeleteLayer

RenameLayer