Initializing help system before first use

XPRS

Xpress license. More...

Public Member Functions
  XPRS (char const *licpath=nullptr)
  Initialize Xpress.
 
  ~XPRS () noexcept
  Destructor.
 

Static Public Member Functions
static bool  getMessageStatus (int msgcode)
  Retrieves the current global suppression status of a message.
 
static void  setMessageStatus (int msgcode, bool enabled)
  Manages global suppression of messages.
 

Detailed Description

Xpress license.

Instances of this class represent an acquired license. They follow the RAII pattern in the sense that the constructor acquires the license and the destructor releases it. This allows for proper cleanup even if the code is exited by means of an exception.

Since
44.00

Constructor & Destructor Documentation

XPRS()

xpress::XPRS::XPRS ( char const * licpath = nullptr )
inline

Initialize Xpress.

This constructor initializes Xpress with license pointer to by licpath. When the object created by this constructor goes out of scope, its destructor will release the license.

Parameters
licpath The path at which to find the Xpress license. If this is nullptr or an empty string then the license is searched in the default location.
Since
44.00

~XPRS()

xpress::XPRS::~XPRS ( )
inlinenoexcept

Destructor.

This frees any license that was acquired by a constructor (if any).

Since
44.00

Member Function Documentation

getMessageStatus()

static bool xpress::XPRS::getMessageStatus ( int msgcode )
inlinestatic

Retrieves the current global suppression status of a message.

Note that messages can also be suppressed per problem. To get the per problem suppression use XPRSProblem::setMessageStatus().

Parameters
msgcode The id number of the message. Refer to "Return Codes and Error Messages" in the user manual for a list of possible message numbers.
Returns
true if the message is currently not suppressed globally; false otherwise.
Since
48.00

setMessageStatus()

static void xpress::XPRS::setMessageStatus ( int msgcode,
bool enabled )
inlinestatic

Manages global suppression of messages.

Note that messages can also be suppressed per problem using XPRSProblem::setMessageStatus().

Parameters
msgcode The id number of the message. Refer to "Return Codes and Error Messages" in the user manual for a list of possible message numbers.
enabled true if the message is not suppressed; false otherwise.
Since
48.00
The documentation for this class was generated from the following file:
  • xpress.hpp
Parent Topic xpress

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.