psetstatus

Synopsis

Description

psetstatus sets the current status value. The status value is the value returned after each execution of a Pandore operator. This value is operator dependent and can be of the following types:

• an integer;
• a real;
• a character;
• a string;
• SUCCESS / FAILURE.

The status value can be printed out by operator pstatus.

setstatus is useful to build new operator as pure shell script since it allows to set the result of the operator. For example, the following shell script becomes a Pandore operator that checks if an image exist and sets the status to SUCCESS or FAILURE from the result:

#!/bin/sh
if [ -f $1 ]
then
psetstatus SUCCESS
else
psetstatus FAILURE
fi

Parameters

• value can be:
  • an integer;
  • a real;
  • a character;
  • a string;
  • or SUCCESS / FAILURE.

Result

The value set.

Examples

• Set the current value to SUCCESS:

     psetstatus SUCCESS
     pstatus {-> returns value SUCCESS }
  

• Set the current value to -12e20:

     psetstatus -12e20
     pstatus {-> returns value -12e20 }
  

See also

C++ prototype

Not a function.

Version française

Affecte la valeur du statut courant à une valeur donnée.