[Enterprise Extensions only]

Environment::exception

Overview Gets and sets an Exception.
Original class CORBA::Environment


Intended Usage

The exception method is used to get and set the Exception held by an Environment. The Exception returned by the get method continues to be owned by the Environment. Once the Environment is destroyed, the Exception previously returned from the get method is invalid. If the Environment does not hold an Exception, the get function returns a null pointer. The set method assumes ownership of the input Exception.

IDL Syntax

  void exception(CORBA::Exception *new_exception);
  CORBA::Exception *exception() const;

Input parameters

new_exception
A pointer to the new Exception to be held in the Environment. It is valid to pass a null pointer. Ownership of this parameter transfers to the Environment.

Return values

CORBA::Exception *
A pointer to the Exception currently held in the Environment, if any, or a null pointer. Ownership of the return value is maintained by the Environment; the return value must not be freed by the caller.