struct XrlCmdError

Error codes for user callbacks. More...

 
LOGO
 Annotated List  Files  Globals  Hierarchy  Index  Top

Public Methods

Public Static Methods


Detailed Description

Error codes for user callbacks. These are a subset of XrlError

const XrlCmdError  OKAY ()

OKAY

[static]

The default return value. Indicates that the arguments to the XRL method were correct. Inability to perform operation should still return OKAY(), but the return list should indicate the error.

const XrlCmdError  BAD_ARGS (const string& reason = "")

BAD_ARGS

[static]

Return value when the method arguments are incorrect.

const XrlCmdError  COMMAND_FAILED (const string& reason = "")

COMMAND_FAILED

[static]

Return value when the method could not be execute.

operator  XrlError ()

XrlError

[const]

Convert to XrlError (needed for XRL protocol families).

string  str ()

str

[const]

Returns: string containing representation of command error.

XrlErrorCode  error_code ()

error_code

[const]

Returns: the unique identifer number associated with error.

string  note ()

note

[const]

Returns: note associated with origin of error (i.e., the reason).


Generated by: bms on anglepoise.lon.incunabulum.net on Wed Jul 23 10:05:36 2008, using kdoc 2.0a54+XORP.