Tibco::Rv::Status - status code


Tibco-Rv documentation  | view source Contained in the Tibco-Rv distribution.

Index


NAME

Top

Tibco::Rv::Status - status code

SYNOPSIS

Top

   my ( $status ) =
      new Tibco::Rv::Status( status => Tibco::Rv::INVALID_ARG );

   $status = $msg->removeField( $fieldName, $fieldId );
   print "returned: $status\n" if ( $status != Tibco::Rv::OK );




DESCRIPTION

Top

Wrapper class for status codes.

CONSTRUCTOR

Top

$status = new Tibco::Rv::Status( %args )
   %args:
      status => $status

Creates a Tibco::Rv::Status object with the given status. $status should be one of the Tibco::Rv Status Constants, or an equivalent numeric value.

METHODS

Top

$str = $status->toString (or "$status")

Returns a descriptive string of $status. Or, simply use $status in a string context.

$num = $status->toNum (or 0+$status)

Returns the numeric value of $status. Or, simply use $status in a numeric context.

AUTHOR

Top

Paul Sturm <sturm@branewave.com>


Tibco-Rv documentation  | view source Contained in the Tibco-Rv distribution.