Paul Sturm > Tibco-Rv-1.15 > Tibco::Rv::Status

Download:
Tibco-Rv-1.15.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.02   Source  

NAME ^

Tibco::Rv::Status - status code

SYNOPSIS ^

   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 ^

Wrapper class for status codes.

CONSTRUCTOR ^

$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 ^

$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 ^

Paul Sturm <sturm@branewave.com>

syntax highlighting: