pcolgetvalue

Gets numerical value from a collection.

Synopsis

pcolgetvalue name [col_in|-]

Description

pcolgetvalue returns the value of the item name from the collection col_in. The item must be a basic type: Char, Uchar, Short, Ushort, Long, SLong, Float or Double.

The value can then be get with the operator pstatus.

Parameters

name is a string without blank character.

Inputs

col_in: a collection.

Result

Returns the numeric value or FAILURE if the specified item doesn't exist.

Examples

Adds the float value 10.5 in the collection col.pan with the name "foo" and chekcs if the value is in the collection:

  pobject2col image tangram.pan col.pan
  pcolsetvalue foo Float 10.5 col.pan col.pan
  pfile col.pan 
  pcolgetvalue foo col.pan 
  pstatus

C++ prototype

Errc PColGetValue( Collection &col_in, const std::String name );

Version française

Extraction de la valeur d'un élément numérique dans une collection.

Author: Régis Clouard