# WVRResult

## Definition

  `#include <nitro/wvr.h>`

      typedef enum WVRResult
      {
          WVR_RESULT_SUCCESS          = 0 ,
          WVR_RESULT_OPERATING        = 1 ,
          WVR_RESULT_DISABLE          = 2 ,
          WVR_RESULT_INVALID_PARAM    = 3 ,
          WVR_RESULT_FIFO_ERROR       = 4 ,
          WVR_RESULT_ILLEGAL_STATUS   = 5 ,
          WVR_RESULT_VRAM_LOCKED      = 6 ,
          WVR_RESULT_FATAL_ERROR      = 7

      } WVRResult;

## Members

`WVR_RESULT_SUCCESS` | The process completed normally.
`WVR_RESULT_OPERATING` | An asynchronous process has begun normally.
`WVR_RESULT_DISABLE` | The ARM7 component is not supported in the WVR library. The ARM7 components for the TWL platform do not support the WVR library, so the return value of the WVR functions will always be this value.
`WVR_RESULT_INVALID_PARAM` | The parameter assigned to the function is an invalid value.
`WVR_RESULT_FIFO_ERROR` | There was a communications failure via the FIFO with ARM7.
`WVR_RESULT_ILLEGAL_STATUS` | The process could not be executed due to the internal state of the WVR. Occurs if the next asynchronous function was called before the callback for an asynchronous function was called, or when operations to start and stop the wireless library overlapped each other.
`WVR_RESULT_VRAM_LOCKED` | The process could not be executed because the VRAM bank is being allocated for other applications via another library (GX).
`WVR_RESULT_FATAL_ERROR` | The process has failed due to some unforeseen reason that does not normally occur. When this error is generated, the cause is generally thought to be due to damage outside the memory that the library uses.

## Description

Enumerated type that shows the results of the shared process in the WVR function. It is shared with the `result` argument that is passed to the callback function of the asynchronous process function.

## Revision History

2008/05/22 Added an explanation about the return values of the functions on the TWL platform.
2005/02/16 Initial version.

CONFIDENTIAL