pcolremoveitem

Removes item from collection.

Synopsis

pcolremoveitem name [col_in|-] [col_out|-]

Description

pcolremoveitem deletes the specified item name from the input collection col_in. The result collection is saved in the output collection col_out.

Parameters

name is the name of the input item. It is a string without blank character.

Inputs

col_in: a collection.

Outputs

col_out: a collection.

Result

Returns SUCCESS or FAILURE if the specified item does not exist.

Examples

Removes the item "foo" from the collection col.pan:

  pobject2col foo tangram.pan col.pan
  pcolremoveitem foo col.pan col.pan
  pfile col.pan

C++ prototype

Errc PColRemoveItem( const Collection &col_in_out, const std::string &name );

Version française

Suppression d'un élément dans une collection.

Author: Alexandre Duret-Lutz